Skip to main content

Documentation Index

Fetch the complete documentation index at: https://septemberai.mintlify.app/llms.txt

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

When the agent pauses to ask a question or request permission, it emits an hitl_request SSE event and waits. You answer through these endpoints.

POST /hitl/respond

Answer a pending HITL request. The agent loop resumes immediately.

Request

POST /hitl/respond
X-Engine-Key: <key>
Content-Type: application/json

{
  "task_id": "task-001",
  "answer": "yes",
  "feedback": "Looks correct, go ahead.",
  "content_blocks": []
}
FieldTypeRequiredPurpose
task_idstringyesThe task whose agent is paused.
answerstringyesThe user’s answer. For permission prompts: "yes" / "no". For questions: free text.
feedbackstringnoAdditional commentary the agent should consider.
content_blocksarraynoStructured content (e.g. images, files) to include in the response.

Response

{
  "status": "resumed",
  "request_id": "hitl-..."
}
Or 404 if no HITL request is pending for the given task.

GET /hitl/pending

List HITL requests waiting for a response, across all tasks.

Request

GET /hitl/pending
X-Engine-Key: <key>

Response

{
  "pending": [
    {
      "request_id": "hitl-...",
      "task_id": "task-001",
      "kind": "permission",
      "question": "Should I delete /tmp/foo?",
      "created_at": "2026-04-27T12:34:56.000Z"
    }
  ]
}

See also