BRbraiv
Shorts

Create shorts, a promo, or clips

Queues the selected shorts-family workflow. The request is discriminated by kind; fields accepted by one variant are not forwarded to another. Poll getShorts until it returns 200 or 422. Required scope: shorts:write.

post/videos/{videoId}/shorts

Request

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

Path parameters

videoIdstring required

Braiv library video document ID.

Headers

Idempotency-Keystring

Caller-generated key for safe POST retries. The API retains the first JSON response for 24 hours. Reusing a key with another path or body returns 409 IDEMPOTENCY_REPLAY.

Request body

OR
OR

Example request

{
  "clipSelectionPrompt": "Prioritise practical explanations from the main speaker and avoid introductions."
}

Response

Shorts-family request queued.

shortsRequestIdstring required

Created shorts-family request ID.

jobIdstring required

Pollable shorts job ID.

creditsSpentnumber required

Credits charged or consumed from escrow.

balancenumber required

Remaining account credit balance.

Changes

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