Clipping

Get the status of a clipping and its clips. Poll it (every 30 seconds is plenty) until the status is completed or failed.

A completed clipping can still carry failed clips: every clip has its own status. When the status is failed no clip was made and the clipping minutes were given back.

get/clipping/{id}

Request

  • Base URL
    https://api.postiz.com/public/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the clipping

Response

The clipping and its clips

idstring
urlstring

The YouTube URL that was clipped

status'analysing' | 'transcribing' | 'picking' | 'rendering' | 'completed' | 'failed'

The step the clipping is on. completed and failed are final

errorstring nullable

Why the clipping failed. A completed clipping can also carry an error when something after the rendering (like the draft posts) went wrong

titlestring nullable

Title of the source video, known after the analysing step

thumbnailstring nullable

Thumbnail of the source video

durationinteger nullable

Length of the source video in seconds

createdAtstring date-time

Changes