Skip to main content
POST
Publish an artifact

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Body

application/json
videoJobId
string
required

Completed video job id for the artifact to queue.

Required string length: 1 - 200
connectedAccountId
string
required

Authorized connected publishing account that will receive the artifact.

Required string length: 1 - 200
caption
string

Optional platform-ready caption; omit for an empty caption.

Maximum string length: 10000
scheduledAt
string<date-time>

Optional RFC 3339 publish time; omit to request immediate policy-gated delivery.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Success.

success
boolean
required
queueItemId
string
required
Required string length: 1 - 200
status
string
required
{key}
any