Media API | Portico

GET/v1/media/{grant}Read mediaplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_grant

Parameters

Name	In	Type	Description
`grant`required	path	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstorage_offlineinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/{grant}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/{grant}/{file}Read mediaplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_grant_file

Parameters

Name	In	Type	Description
`grant`required	path	`string`
`file`required	path	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstorage_offlineinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/{grant}/{file}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/{grant}/audioRead media audioplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_grant_audio

Parameters

Name	In	Type	Description
`grant`required	path	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/{grant}/audio" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

HEAD/v1/media/{grant}/audioRead headers for media audioplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: head_media_grant_audio

Parameters

Name	In	Type	Description
`grant`required	path	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/{grant}/audio" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/{grant}/audio-convertedRead media audio convertedplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_grant_audio_converted

Parameters

Name	In	Type	Description
`grant`required	path	`string`
`fromFrame`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/{grant}/audio-converted" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/{grant}/audio-indexRead the seek index of media audioplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_grant_audio_index

Parameters

Name	In	Type	Description
`grant`required	path	`string`

Responses

200Successapplication/json

Example

{
  "frames": [
    0
  ],
  "offsets": [
    0
  ],
  "version": 0
}

Schema

framesarray of integerrequired
offsetsarray of integerrequired
versionintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/{grant}/audio-index" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/linear/{playbackId}/{generation}/{token}/{name}Read media linearplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: get_media_linear_playbackId_generation_token_name

Parameters

Name	In	Type
`playbackId`required	path	`string`
`generation`required	path	`string`
`token`required	path	`string`
`name`required	path	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/linear/{playbackId}/{generation}/{token}/{name}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/media/subtitles/{grant}/{resource}/{revision}Read or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/json

Example

{
  "cues": [
    {
      "endUs": "string",
      "italic": true,
      "startUs": "string",
      "text": "string",
      "top": true
    }
  ],
  "skippedCues": 0,
  "timeDomain": "2026-10-18T19:30:00Z",
  "version": 0
}

Schema

cuesarray of objectrequired
- endUsstringrequired
- italicboolean
- startUsstringrequired
- textstringrequired
- topboolean
skippedCuesinteger
timeDomainstringrequired
versionintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}"

GET/v1/media/subtitles/{grant}/{resource}/{revision}.vttRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_vtt

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/vtt

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}.vtt"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/fontsRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_fonts

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/json

Example

{
  "fonts": [
    {
      "name": "Fargo",
      "url": "https://example.com/…"
    }
  ],
  "skippedCount": 0
}

Schema

fontsarray of objectrequired
- namestringrequired
- urlstringrequired
skippedCountinteger

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/fonts"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/fonts/{font}Read or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_fonts_font

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`font`required	path	`string`
`segment`	query	`string`

Responses

200Successfont/ttf

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/fonts/{font}"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/fonts/{font}Read or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_fonts_font

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`font`required	path	`string`
`segment`	query	`string`

Responses

200Successfont/ttf

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/fonts/{font}"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/linesRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_lines

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/json

Example

{
  "forced": 0,
  "total": 0
}

Schema

forcedintegerrequired
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/lines"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.assRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_ass

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/x-ssa

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.ass"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.assRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_ass

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/x-ssa

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.ass"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.idxRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_idx

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/plain

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.idx"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.idxRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_idx

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/plain

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.idx"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.mksRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_mks

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.mks"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.mksRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_mks

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.mks"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.ssaRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_ssa

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/x-ssa

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.ssa"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.ssaRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_ssa

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successtext/x-ssa

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.ssa"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.subRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_sub

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.sub"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.subRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_sub

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.sub"

GET/v1/media/subtitles/{grant}/{resource}/{revision}/original.supRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: get_v1_media_subtitles_grant_resource_revision_original_sup

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.sup"

HEAD/v1/media/subtitles/{grant}/{resource}/{revision}/original.supRead or change authorized subtitlesopen

Audience: Clients · Native API
Authorization: No credential needed
OpenAPI operation ID: head_v1_media_subtitles_grant_resource_revision_original_sup

Parameters

Name	In	Type
`grant`required	path	`string`
`resource`required	path	`string`
`revision`required	path	`string`
`segment`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X HEAD "http://127.0.0.1:32500/v1/media/subtitles/{grant}/{resource}/{revision}/original.sup"