Invoke

Invoke the agent with a message and get a response.

POST /agent/invoke

Invoke

cURL

curl --request POST \
  --url https://api.example.com/agent/invoke \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>",
  "query": "<string>"
}
'

200

{
  "session_id": "<string>",
  "response": "<string>"
}

Body

application/json

Request payload for synchronous and streaming chat endpoints.

Attributes: session_id: Client-provided session identifier for routing state. query: Natural language prompt or input for the agent.

session_id · string · required

query · string · required

Response

200

application/json

Successful Response

Response payload for chat endpoints.

Attributes: session_id: Echoed session identifier. response: Agent's textual response.

session_id · string · required

response · string · required