Skip to content
calternal docs

Get an HLS playlist or segment

GET
/api/v1/video/{item_id}/hls/{height}/{name}
curl --request GET \
  --url https://example.com/api/v1/video/example/hls/1/example \
  --header 'Authorization: Bearer <token>'

Return a playlist or media segment for one video rendition. Use height 720 or 1080 and give index.m3u8 or a valid segment name. A missing playlist returns 202 while the server prepares it; a missing segment returns 404. Route: /api/v1/video/{item_id}/hls/{height}/{name}. Inputs: item_id, height, name. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
item_id
required
string
height
required
integer format: int32
name
required
string

Responses

Section titled “Responses”

200

Section titled “200”

HLS media segment

Media typevideo/mp2t

206

Section titled “206”

HLS byte range

Media typevideo/mp2t

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

416

Section titled “416”