Skip to main content
POST
/
api
/
conversations
/
{conversation_id}
/
events
Send Message
curl --request POST \
  --url https://api.example.com/api/conversations/{conversation_id}/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "user",
  "content": [
    {
      "text": "<string>",
      "cache_prompt": false,
      "type": "text"
    }
  ],
  "run": false
}
'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://allhandsai-docs-agent-canvas-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
conversation_id
string<uuid>
required

Body

application/json

Payload to send a message to the agent.

This is a simplified version of openhands.sdk.Message.

​
role
enum<string>
default:user
Available options:
user,
system,
assistant,
tool
​
content
(TextContent · object | ImageContent · object)[]
​
run
boolean
default:false

Whether the agent loop should automatically run if not running

Response

Successful Response

​
success
boolean
default:true