Sign in
latestOpenAPI 3.1.12026-08-22330162.7 KB

35448566f143

Publishing

Get publication status

Returns the current status of a publication. Poll this after POST /publications to track progress.

Status flow: Immediate publishes typically move exporting -> uploading -> published (or failed at any stage). Scheduled publishes may move into scheduled first, depending on platform behavior.

Polling recommendation: Check every 10-15 seconds until the upload reaches a stable state such as published, scheduled, or failed.

get/publications/{publicationId}

Path parameters

publicationIdstring uuid required

Publication ID from POST /publications.

Response

OK

idstring uuid required

Publication ID.

videoIdstring uuid required

The video ID being published.

channelIdstring uuid required

Target channel ID.

titlestring required

Video title as published.

descriptionstring nullable required

Description/caption as published.

status'draft' | 'scheduled' | 'exporting' | 'uploading' | 'published' | 'failed' | 'canceled' required

Current publication status.

  • exporting: Video MP4 is being rendered.
  • uploading: Uploading to the platform.
  • scheduled: The platform accepted a future publish time and is waiting.
  • published: Upload completed on the platform. If scheduledAt is in the future, the platform may still be waiting to make it public.
  • failed: Something went wrong. Check errorMessage.
  • canceled: The scheduled publication was canceled before going live.
platformVideoIdstring nullable required

Video ID on the platform (e.g. YouTube video ID). Available after publishing.

platformVideoUrlstring nullable required

Direct URL to the published video. Available after publishing.

errorMessagestring nullable required

Error details if status is failed.

scheduledAtstring date-time nullable required

When the video is scheduled to publish. Null if publishing immediately.

publishedAtstring date-time nullable required

When the video was actually published.

createdAtstring date-time required

When the publication was created (ISO 8601).