AgentsMessages

Send Message Async

Asynchronously process a user message and return a run object. The actual processing happens in the background, and the status can be checked using the run ID.

Path parameters

agent_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
messageslist of objectsRequired

The messages to be sent to the agent.

use_assistant_messagebooleanOptionalDefaults to true

Whether the server should parse specific tool call arguments (default send_message) as AssistantMessage objects.

assistant_message_tool_namestringOptionalDefaults to send_message

The name of the designated message tool.

assistant_message_tool_kwargstringOptionalDefaults to message

The name of the message argument in the designated message tool.

Response

Successful Response

created_by_idstringOptional

The id of the user that made this object.

last_updated_by_idstringOptional

The id of the user that made this object.

created_atdatetimeOptional

The timestamp when the object was created.

updated_atdatetimeOptional

The timestamp when the object was last updated.

statusenumOptional

The status of the job.

completed_atdatetimeOptional

The unix timestamp of when the job was completed.

metadatamap from strings to anyOptional

The metadata of the job.

job_typeenumOptional
Allowed values:
callback_urlstringOptional

If set, POST to this URL when the job completes.

callback_sent_atdatetimeOptional

Timestamp when the callback was last attempted.

callback_status_codeintegerOptional

HTTP status code returned by the callback endpoint.

idstringOptionalformat: "^(job|run)-[a-fA-F0-9]{8}"

The human-friendly ID of the Run

request_configobjectOptional

The request configuration for the run.

Errors