Send Message Async

POST
/v1/agents/:agent_id/messages/async

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

Path parameters

agent_idstringRequired

Request

This endpoint expects an object.
messageslist of objectsRequired

The messages to be sent to the agent.

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_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp when the object was created.

updated_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp when the object was last updated.

statusenumOptional
Allowed values: createdrunningcompletedfailedpending

The status of the job.

completed_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The unix timestamp of when the job was completed.

metadata_map from strings to anyOptional

The metadata of the job.

idstringOptionalformat: "^job-[a-fA-F0-9]{8}"

The human-friendly ID of the Job

user_idstringOptional

The unique identifier of the user associated with the job.

Errors