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>"
}
'
{
  "summary": "<string>",
  "key_points": [
    "<string>"
  ],
  "suggested_next_action": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pragmatiks.io/llms.txt

Use this file to discover all available pages before exploring further.

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