Skip to main content
v1Stable

Send a Message

Send a message to an Apollo-1 agent and receive the complete response, optionally including the symbolic reasoning trace.
cURL

POST /v1/messaging/messages

Base URL: https://api.aui.io

Headers

HeaderRequiredDescription
x-aui-api-keyYesYour API key
Content-TypeYesMust be application/json

Query Parameters

include_trace
boolean
default:"false"
Include the symbolic reasoning trace in the response. Adds trace_info field.

Request Body

type
string
required
Message type. Must be "message".
task_id
string
required
The task identifier (conversation thread).
text
string
required
The message content to send to the agent.
agent_settings_bundle
object
Optional agent configuration bundle to test local changes without deploying.

Response

Returns a message response object containing the agent’s reply.
id
string
Unique message identifier. This is also the interaction ID used for rerun and trace endpoints.
text
string
The agent’s response message.
followup_suggestions
array
AI-generated follow-up question suggestions.
trace_info
object
Symbolic reasoning trace (only included when ?include_trace=true).

Code Examples


Rerun an Interaction

Regenerate a previous interaction with edited text or updated agent configuration.
cURL

POST /v1/messaging/messages/rerun

Headers

HeaderRequiredDescription
x-aui-api-keyYesYour API key
x-aui-user-idYesUser identifier (acting user for this rerun)
Content-TypeYesMust be application/json

Query Parameters

include_trace
boolean
default:"false"
Include trace info in the regenerated response.

Request Body

task_id
string
required
The original task identifier.
interaction_id
string
required
The message ID to regenerate (from a previous send-message response).
text
string
required
The message to replay (can be the original or edited).
agent_id
string
required
The agent management ID.
version_id
string
Pin to a specific version for this rerun.
version_tag
string
Pin to a specific revision tag.
agent_settings_bundle
object
Optional agent configuration bundle to test changes.

Response

regenerated_task_id
string
The new task ID created for the regenerated conversation branch.
message
object
The agent’s response in the regenerated branch (same structure as send-message response).

Errors

StatusDescription
401Missing or invalid x-aui-api-key header
422Validation error — invalid request parameters or agent bundle
400Application error — may include moderation or processing details
401
422 - Invalid Bundle
422 - Missing Parameters