Deployments.ai Docs
Runtime

Publish a confirmed externally delivered automation message

POST /v1/threads/{threadId}/runs/{runId}/message/publications · SDK publishRunMessage · CLI deployments run publish-message

POST
/v1/threads/{threadId}/runs/{runId}/message/publications

Requires runs:write.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

threadId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
runId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string

Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.

Match^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$
Length1 <= length <= 256

Request Body

application/json
  1. body
content*string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length

Response Body

MessageResponse

application/json
  1. response
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
agentDeploymentId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
body?string
bodyAccess?
contentHash*string
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
inputArtifacts?array<string>
inputOmissions?array<>
metadata?
object*"message"
Value in"message"
role*string
Value in"assistant""system""tool""user"
runId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
sequence*number|||
streamEventId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
threadId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
unlistedInputOmissions?integer
Range1 <= value
curl -X POST "https://example.com/v1/threads/string/runs/string/message/publications" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "content": "string"  }'
{  "environmentId": "string",  "organizationId": "string",  "projectId": "string",  "agentDeploymentId": "string",  "body": "string",  "bodyAccess": {    "byteSize": 0,    "contentType": "string",    "expiresAt": "2019-08-24T14:15:22Z",    "sha256": "string",    "url": "string"  },  "contentHash": "string",  "createdAt": "2019-08-24T14:15:22Z",  "id": "string",  "inputArtifacts": [    "string"  ],  "inputOmissions": [    {      "name": "string",      "reason": "too_large"    }  ],  "metadata": {    "property1": null,    "property2": null  },  "object": "message",  "role": "assistant",  "runId": "string",  "sequence": 0,  "streamEventId": "string",  "threadId": "string",  "unlistedInputOmissions": 1}