OCT-103 Gumlet outreach
POST/video/assets/{asset_ID}/subtitle/upload

Create subtitle upload URLs

Creates signed upload URLs for adding subtitle files to a video asset. Supply language_codes to request URLs for the subtitle languages you plan to upload, then send each .srt or .vtt file to its URL with a PUT request. Call the subtitle upload completion operation after all files have been uploaded.

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

1 parameter · 1 body field
asset_IDstringrequired

The identifier of the video asset to which you are adding subtitles.

Subtitle upload settings, including the language codes for which to create signed upload URLs.

language_codesarray<string>optional

List of language codes to upload subtitle file (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes)

5 status codes
200Returns the asset ID and a signed_urls array containing a language code and upload URL for each requested language.
asset_idstringrequired

Asset ID of Gumlet

signed_urlsarray<object>required

List of objects with signed URLs for each language

400Returned when the request is invalid.

One documented failure

  • invalid_language_code

    Invalid language code. It must be one of the ISO 639-1 assigned codes.

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
403Returned when the account is unpaid or the authenticated user lacks the required 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 is returned for a bad request, a 401 when the API key or bearer token is missing or invalid, a 403 for an unpaid account or insufficient role permissions, and a 500 for an internal server error. The asset_ID path parameter must identify the asset receiving the subtitles; use ISO 639-1 codes for language_codes when supplied.