Skip to content
Picogrid Legion

Get video download status

Get video download status

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

Get the status of a download of an mp4 clip. Once the download is complete, the presigned_url will be returned. Downloads will be available for 24 hours, after that the returned url is invalid

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The id of the stream you want to get video download status for

download_id
required
string

The id of the download that you got in the return value of the POST request to start a video download

Query Parameters

Section titled “Query Parameters”
start
string

The earliest timestamp you want included in your query. It defaults to the beginning of time. The format is a string containing an integer in epoch milliseconds as explained further here: https://en.wikipedia.org/wiki/Unix_time

end
string

The latest timestamp you want included in your query. It defaults to the end of time. The format is a string containing an integer in epoch milliseconds as explained further here: https://en.wikipedia.org/wiki/Unix_time

org_id
string

The id of the organization to get the video download status for

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
message
string
presigned_url
string format: uri
status
required
string
Allowed values: PROCESSING SUCCESS FAILED
Example
{
  "status": "PROCESSING"
}

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