Skip to main content
POST
Send Http Text Message
Integration Prompt for AI Agents
This endpoint allows you to send HTTP text messages to an active HTTP text simulation run.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Body

application/json

Chat message: Send a message to the user.

simulation_result_id
string
required

ID of the simulation result (test result)

message
string
required

Text message to send

end_conversation
boolean | null
default:false

If true, skip lambda and end/evaluate the conversation

end_turn
boolean | null
default:true

If true, process the message now; if false, stack it for later

message_id
string | null

Unique message ID for deduping within a conversation

type
string
default:message

Send a message to the user

Allowed value: "message"

Response

Successful Response

Response model for HTTP text message

simulation_result_id
string
required

Simulation result ID

status
string
default:success

Status of the response

end_conversation
boolean
default:false

Whether the conversation has ended