ORorq-ai
Agents

Stream agent execution in real-time

Changed on

Stream an existing agent execution in real-time via SSE, providing live message chunks, tool calls, and status updates until completion.

post/v2/agents/{key}/stream-task

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/agents/{key}/stream-task
  • Auth
    HTTP bearer

Path parameters

keystring required

The key or ID of the agent to invoke

Request body

task_idstring

Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue.

variablesobject

Optional variables for template replacement in system prompt, instructions, and messages

metadataobject

Optional metadata for the agent invocation as key-value pairs that will be included in traces

engine'text' | 'jinja' | 'mustache'

Override template engine for this invocation. If not provided, uses the agent default.

stream_timeout_secondsnumber

Stream timeout in seconds (1-3600). Default: 1800 (30 minutes)

Example request

{
  "message": {
    "parts": [
      {
        "file": {
          "uri": "https://example.com/report.pdf"
        }
      }
    ]
  },
  "identity": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "jane.doe@example.com",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "contact": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "jane.doe@example.com",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "thread": {
    "id": "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "tags": [
      "customer-support",
      "priority-high"
    ]
  }
}

Response

Server-Sent Event stream successfully established. Returns real-time events including agent messages, tool calls, status updates, and completion signals. The stream ends with a [DONE] sentinel value.

Changes

  • 0b4e519a544fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 732aed62833aRevision changes
    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property //// from the response with the status