Skip to navigation
Runtime API TemplateChannels

Post a user message into a channel

Authentication

AuthorizationBearer

OAuth/JWT bearer with the ‘runtime’ scope that resolves to a user principal. API keys and agent service tokens are rejected by user-delegated operations.

Path parameters

channelIdstringRequired
Channel id.

Headers

X-CES-Workspace-IDstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"
Optional Workspace runtime selector header. If supplied with workspaceId, both values must match.

Query parameters

agentIdstringOptional
Optional agent participant id filter within this app.
workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Request

This endpoint expects an object.
contentstringRequired
messageIdstringOptional

Optional caller-provided idempotency/message id.

attachmentslist of maps from strings to anyOptional
pageContextmap from strings to anyOptional
agentIdstringOptional
Optional agent participant id to scope posting within this app.
agentTurnContextobjectOptional

Private, turn-scoped agent orientation for the associated channel message. It is not returned by channel message APIs.

agentSessionContextobjectOptional
Compatibility alias for agentTurnContext. Send only one of these fields.

Response

Message accepted
messageIdstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error