Get shorts outputs

GET

/shorts/{shortsRequestId}

curl --request GET \
  --url https://api.braiv.co/v1/shorts/shorts_01JZA \
  --header 'Authorization: Bearer <token>'

• Braiv Public API

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

Authorizations

• bearerAuth
• apiKeyHeader

Parameters

Path Parameters

shortsRequestId

required

string

>= 1 characters

Shorts request document ID returned by createShorts.

Example

shorts_01JZA

Responses

200

Request completed fully or partially; inspect status and outputs.

Media type application/json

object

shortsRequestId

required

Shorts request ID.

string

status

required

Current request lifecycle.

string

Allowed values: pending queued processing complete partial_failed failed

clipsExpected

Planned number of outputs.

integer

jobId

required

Pollable shorts job ID.

string

outputs

required

All available non-deleted generated outputs for the request.

Array<object>

object

outputId

required

Generated output ID.

string

type

Output family.

string

Allowed values: shorts promo clips

videoUrl

Playback URL for the generated video.

string format: uri

thumbnailUrl

Generated output thumbnail URL.

string format: uri

duration

Output duration in seconds.

number

title

Generated output title.

string

description

Generated output summary.

string

Example

{
  "shortsRequestId": "req_01JZA",
  "status": "partial_failed",
  "clipsExpected": 3,
  "jobId": "shorts_req_01JZA",
  "outputs": [
    {
      "outputId": "out_01",
      "type": "shorts",
      "videoUrl": "https://cdn.braiv.co/out_01.mp4",
      "thumbnailUrl": "https://cdn.braiv.co/out_01.jpg",
      "duration": 42.5,
      "title": "Three launch lessons"
    }
  ]
}

202

Request is pending or processing; outputs may be incomplete.

Media type application/json

object

shortsRequestId

required

Shorts request ID.

string

status

required

Current request lifecycle.

string

Allowed values: pending queued processing complete partial_failed failed

clipsExpected

Planned number of outputs.

integer

jobId

required

Pollable shorts job ID.

string

outputs

required

All available non-deleted generated outputs for the request.

Array<object>

object

outputId

required

Generated output ID.

string

type

Output family.

string

Allowed values: shorts promo clips

videoUrl

Playback URL for the generated video.

string format: uri

thumbnailUrl

Generated output thumbnail URL.

string format: uri

duration

Output duration in seconds.

number

title

Generated output title.

string

description

Generated output summary.

string

Example

{
  "shortsRequestId": "req_01JZA",
  "status": "processing",
  "clipsExpected": 3,
  "jobId": "shorts_req_01JZA",
  "outputs": []
}

401

A supported authentication header is missing or contains an invalid Public API key.

Media type application/json

object

error

required

Structured public API error envelope.

object

code

required

Stable machine-readable error code.

string

Allowed values: UNAUTHENTICATED INVALID_API_KEY INSUFFICIENT_SCOPE PERMISSION_DENIED ROLE_CANNOT_PRODUCE NOT_FOUND INVALID_ARGUMENT UNSUPPORTED_SOURCE DURATION_UNKNOWN INSUFFICIENT_CREDITS CONFLICT ALREADY_EXISTS IDEMPOTENCY_REPLAY RATE_LIMITED PREVIEW_NOT_DOWNLOADABLE DOWNLOAD_TIER_NONE FAILED_PRECONDITION GONE METHOD_NOT_ALLOWED INTERNAL

message

required

Human-readable error summary.

string

details

required

Machine-readable operation-specific context; empty when unavailable.

object

key

additional properties

any

Examples

Authentication header missing

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Missing API key.",
    "details": {}
  }
}

API key invalid

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key",
    "details": {}
  }
}

403

Authentication succeeded, but the required scope, workspace role, or resource permission is missing.

Media type application/json

object

error

required

Structured public API error envelope.

object

code

required

Stable machine-readable error code.

string

Allowed values: UNAUTHENTICATED INVALID_API_KEY INSUFFICIENT_SCOPE PERMISSION_DENIED ROLE_CANNOT_PRODUCE NOT_FOUND INVALID_ARGUMENT UNSUPPORTED_SOURCE DURATION_UNKNOWN INSUFFICIENT_CREDITS CONFLICT ALREADY_EXISTS IDEMPOTENCY_REPLAY RATE_LIMITED PREVIEW_NOT_DOWNLOADABLE DOWNLOAD_TIER_NONE FAILED_PRECONDITION GONE METHOD_NOT_ALLOWED INTERNAL

message

required

Human-readable error summary.

string

details

required

Machine-readable operation-specific context; empty when unavailable.

object

key

additional properties

any

Examples

Example scope

{
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "The API key lacks the required scope.",
    "details": {}
  }
}

404

The resource does not exist or is not accessible to the caller.

Media type application/json

object

error

required

Structured public API error envelope.

object

code

required

Stable machine-readable error code.

string

Allowed values: UNAUTHENTICATED INVALID_API_KEY INSUFFICIENT_SCOPE PERMISSION_DENIED ROLE_CANNOT_PRODUCE NOT_FOUND INVALID_ARGUMENT UNSUPPORTED_SOURCE DURATION_UNKNOWN INSUFFICIENT_CREDITS CONFLICT ALREADY_EXISTS IDEMPOTENCY_REPLAY RATE_LIMITED PREVIEW_NOT_DOWNLOADABLE DOWNLOAD_TIER_NONE FAILED_PRECONDITION GONE METHOD_NOT_ALLOWED INTERNAL

message

required

Human-readable error summary.

string

details

required

Machine-readable operation-specific context; empty when unavailable.

object

key

additional properties

any

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found.",
    "details": {}
  }
}

422

Request failed with no successful terminal result.

Media type application/json

object

shortsRequestId

required

Shorts request ID.

string

status

required

Current request lifecycle.

string

Allowed values: pending queued processing complete partial_failed failed

clipsExpected

Planned number of outputs.

integer

jobId

required

Pollable shorts job ID.

string

outputs

required

All available non-deleted generated outputs for the request.

Array<object>

object

outputId

required

Generated output ID.

string

type

Output family.

string

Allowed values: shorts promo clips

videoUrl

Playback URL for the generated video.

string format: uri

thumbnailUrl

Generated output thumbnail URL.

string format: uri

duration

Output duration in seconds.

number

title

Generated output title.

string

description

Generated output summary.

string

Example

{
  "shortsRequestId": "req_01JZA",
  "status": "failed",
  "clipsExpected": 3,
  "jobId": "shorts_req_01JZA",
  "outputs": []
}

429

The API key exceeded its allowed concurrency or request rate. Retry after in-flight work completes or the limit resets.

Media type application/json

object

error

required

Structured public API error envelope.

object

code

required

Stable machine-readable error code.

string

Allowed values: UNAUTHENTICATED INVALID_API_KEY INSUFFICIENT_SCOPE PERMISSION_DENIED ROLE_CANNOT_PRODUCE NOT_FOUND INVALID_ARGUMENT UNSUPPORTED_SOURCE DURATION_UNKNOWN INSUFFICIENT_CREDITS CONFLICT ALREADY_EXISTS IDEMPOTENCY_REPLAY RATE_LIMITED PREVIEW_NOT_DOWNLOADABLE DOWNLOAD_TIER_NONE FAILED_PRECONDITION GONE METHOD_NOT_ALLOWED INTERNAL

message

required

Human-readable error summary.

string

details

required

Machine-readable operation-specific context; empty when unavailable.

object

key

additional properties

any

Example

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API key concurrency limit reached",
    "details": {}
  }
}

500

An unexpected server error occurred.

Media type application/json

object

error

required

Structured public API error envelope.

object

code

required

Stable machine-readable error code.

string

Allowed values: UNAUTHENTICATED INVALID_API_KEY INSUFFICIENT_SCOPE PERMISSION_DENIED ROLE_CANNOT_PRODUCE NOT_FOUND INVALID_ARGUMENT UNSUPPORTED_SOURCE DURATION_UNKNOWN INSUFFICIENT_CREDITS CONFLICT ALREADY_EXISTS IDEMPOTENCY_REPLAY RATE_LIMITED PREVIEW_NOT_DOWNLOADABLE DOWNLOAD_TIER_NONE FAILED_PRECONDITION GONE METHOD_NOT_ALLOWED INTERNAL

message

required

Human-readable error summary.

string

details

required

Machine-readable operation-specific context; empty when unavailable.

object

key

additional properties

any

Example

{
  "error": {
    "code": "INTERNAL",
    "message": "An unexpected error occurred.",
    "details": {}
  }
}