Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
content
string
required

Text of the task, follow-up, or steering instruction to send to the session agent.

Required string length: 1 - 1000000
sessionId
string<uuid>
required

Session to receive this message. Use this operation to continue work in an existing session.

artifactId
string<uuid>

Artifact to associate with this message.

mcpServers
string[]

MCP server or connection IDs selected for this message.

Maximum array length: 100
Required string length: 1 - 200
pullRequestId
string<uuid>

Pull request to associate with this message.

agentOptions
object

Agent-specific runtime options for this message, such as reasoning effort.

deliveryMode
enum<string>

queue adds a follow-up task; steer sends guidance to an active agent turn when supported.

Available options:
queue,
steer
richContent
object

Optional rich-text representation of the message. Provide the required text content separately.

Example:
slashCommand
object

Structured slash command to execute with this message.

Response

Create a message

hotPath
object | null
required
job
object | null
required
message
object
required
session
object
required