Trigger a chat run (fire-and-forget)

curl --request POST \
  --url https://api.example.com/chat/ \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "agent_id": "<string>",
  "session_id": "<string>",
  "input": {
    "name": "<string>",
    "content": [
      {
        "text": "<string>",
        "type": "text",
        "id": "<string>"
      }
    ],
    "id": "<string>",
    "metadata": {},
    "created_at": "<string>",
    "finished_at": "<string>",
    "usage": {
      "input_tokens": 123,
      "output_tokens": 123
    }
  }
}
'

{
  "session_id": "<string>",
  "status": "started"
}

chat

Trigger a chat run (fire-and-forget)

Trigger a chat run for the specified session.

The run executes as a background task. Events produced during the run are published to the message bus and delivered to any active GET /sessions/{session_id}/stream SSE subscriber. The caller does not receive events from this endpoint’s response body.

Accepts the same input payloads as before:

Msg / list[Msg]: new user message(s).
UserConfirmResultEvent / ExternalExecutionResultEvent: resume a paused tool call (human-in-the-loop).
None: continue from current state.

Args: request (ChatRequest): JSON body with agent_id, session_id, and input. user_id (str): Injected user id. chat_service (ChatService): Injected application-wide chat service.

Returns: ChatTriggerResponse: Confirms the run was scheduled.

POST

chat

Trigger a chat run (fire-and-forget)

curl --request POST \
  --url https://api.example.com/chat/ \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "agent_id": "<string>",
  "session_id": "<string>",
  "input": {
    "name": "<string>",
    "content": [
      {
        "text": "<string>",
        "type": "text",
        "id": "<string>"
      }
    ],
    "id": "<string>",
    "metadata": {},
    "created_at": "<string>",
    "finished_at": "<string>",
    "usage": {
      "input_tokens": 123,
      "output_tokens": 123
    }
  }
}
'

{
  "session_id": "<string>",
  "status": "started"
}

Headers

x-user-id

string

required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Body

application/json

Request body for the chat endpoint.

agent_id

string

required

Agent ID for the chat endpoint.

session_id

string

required

The session to send the message to.

input

Msg · object

required

The message class in AgentScope, responsible for information storage and transmission among different agents.

Msg · object
Msg · object[]
UserConfirmResultEvent · object
ExternalExecutionResultEvent · object

Show child attributes

Response

Successful Response

Response body for the fire-and-forget chat trigger.

Confirms that the chat run was scheduled. Events produced by the run arrive separately via the session's SSE stream endpoint.

session_id

string

required

Echo of the session id the run was started for.

status

string

default:started

Always "started" when the trigger succeeded.

Update an agent List JSON schemas for all credential types