Skip to content
Picogrid Legion

Get HLS URL for stream

Get HLS URL for stream

Open in ChatGPT ↗Open in Claude ↗
GET
/streams/{id}/hls-url
curl --request GET \
  --url https://us-gov.legion.picogrid.com/v2/streams/example/hls-url

Get HLS URL for viewing live stream. This endpoint is only supported for streams with video. The HLS URL is valid for 12 hours

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The id of the stream you want to get the HLS URL for

Query Parameters

Section titled “Query Parameters”
org_id
string

The id of the organization to get stream hls url for

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
url
required
string format: uri
Examplegenerated
{
  "url": "https://example.com"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

400

Section titled “400”

Bad Request Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

401

Section titled “401”

Authentication Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

403

Section titled “403”

Unauthorized Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

404

Section titled “404”

Resource Not Found Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

408

Section titled “408”

Timeout Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

500

Section titled “500”

Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

502

Section titled “502”

Bad Gateway Error

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Access-Control-Allow-Origin
string
default: *
Example
https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials
boolean
default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

Version 2 · commit 0771262