POST/video/assets/{asset_id}/chapters

Create or update video asset chapters

Creates or updates the chapter list for a video asset. Supply chapters with a label and start time for each chapter; a start time of 0 places a chapter at the beginning of the video. Use this operation to set or replace the asset's chapter information.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
asset_idstringrequired

The unique identifier of the video asset whose chapters you are setting.

Chapter information for the video asset. The chapters list is required.

chaptersarray<object>required

List of chapters

6 status codes
200Returns an empty JSON object after the asset's chapters are created or updated.
400Returned when chapter validation fails.

One documented failure

  • label_missing

    Please provide a label with each chapter.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
402Returned when the account has unpaid invoices.

One documented failure

  • payment_pending

    Please clear your pending invoices to resume your services.

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 indicates chapter validation failed; a 401 indicates a missing or invalid API key or bearer token. A 402 indicates unpaid invoices, a 403 indicates an unpaid account or insufficient role permissions, and a 500 indicates an internal server error. chapters is required, and each chapter must include label and startTime.