BRbraiv
Shorts

Get shorts outputs

Returns up to five non-deleted outputs. partial_failed returns 200 because usable outputs may be present. Required scope: videos:read.

get/shorts/{shortsRequestId}

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

shortsRequestIdstring required

Shorts request document ID returned by createShorts.

Response

Request completed fully or partially; inspect status and outputs.

shortsRequestIdstring required

Shorts request ID.

status'pending' | 'queued' | 'processing' | 'complete' | 'partial_failed' | 'failed' required

Shorts request lifecycle: pending and queued are waiting to run, processing is generating outputs, complete produced all planned outputs, partial_failed produced at least one usable output, and failed produced no usable result. Complete and partial failure responses use HTTP 200; a terminal failure uses HTTP 422.

clipsExpectedinteger

Planned number of outputs.

jobIdstring required

Pollable shorts job ID.

Changes

No recorded changes to this operation across all 1 revision of this API.