Skip to main content
POST
Relay a message to an agent's chat

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

integrationSlug
string
required

The integration where the agent's chat lives, such as github.

Minimum string length: 1
target
Target · object
required

Where on that integration, in its terms. For github: { owner, repo, prNumber }, a pull request a chat in this workspace opened.

text
string
required

The message, in the integration's Markdown.

Required string length: 1 - 60000

Response

Relay a message to an agent's chat

url
string
required

The message on the integration.

isWoken
boolean
required

Whether the chat took the message, now or after the turn it is running.