Skip to main content
POST
Trigger a chat run (fire-and-forget)

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.

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.