Skip to main content
POST
/
agents
/
assists
/
explain-task
Explain Task
curl --request POST \
  --url https://api.example.com/agents/assists/explain-task \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>",
  "correlation_bucket_id": "<string>"
}
'
import requests

url = "https://api.example.com/agents/assists/explain-task"

payload = {
    "task_id": "<string>",
    "correlation_bucket_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({task_id: '<string>', correlation_bucket_id: '<string>'})
};

fetch('https://api.example.com/agents/assists/explain-task', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/agents/assists/explain-task",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'task_id' => '<string>',
    'correlation_bucket_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agents/assists/explain-task"

	payload := strings.NewReader("{\n  \"task_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/agents/assists/explain-task")
  .header("Content-Type", "application/json")
  .body("{\n  \"task_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/assists/explain-task")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"task_id\": \"<string>\",\n  \"correlation_bucket_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "summary": "<string>",
  "key_points": [
    "<string>"
  ],
  "suggested_next_action": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request body for the explain-task assist.

The server fetches the referenced task and, when provided, the correlation bucket so the assist can ground its explanation in the surrounding event stream.

Attributes: task_id: Task to explain. correlation_bucket_id: Optional correlation bucket whose recent events should enrich the explanation.

​
task_id
string
required
​
correlation_bucket_id
string | null

Response

Successful Response

Response body for the explain-task assist.

Attributes: summary: Human-readable summary of the task. key_points: Salient details a reader should know. suggested_next_action: Recommended next step for the assignee.

​
summary
string
required
​
key_points
string[]
required
​
suggested_next_action
string
required