API reference

API reference · Account

One publish

GET/api/studio/publish/jobs/{id}Signed in session

While the platform is processing it, the platform is asked again at most every 20 seconds (TikTok's status; Instagram's container, published once it is ready). The signed in account; same origin for a write.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe publish's id.

Answer 200

The publish.

Fields of the 200 answer
FieldTypeWhat it is
idstring
share_idstring
platformstringOne of "tiktok", "youtube", "instagram".
statestringOne of "sending", "processing", "published", "failed".
urlstring or nullThe post on the platform, once it says.
privacystring or null
errorstring or nullThe platform's own short words.
created_atinteger

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter