Start video download

POST

/streams/{id}/download-video

curl --request POST \
  --url 'https://us-gov.legion.picogrid.com/v2/streams/example/download-video?start=example&end=example'

• The server that hosts the Legion gov API

Start a download of an mp4 clip from a stream. Clips are limited to 100MB in size, and only support downloads from less than 24 hours ago. Downloads will be available for 24 hours, after that the returned id is invalid.

Parameters

Path Parameters

id

required

string

The id of the stream you want to start a video download for

Query Parameters

start

required

string

The timestamp specifying the beginning of the video you want to download. The format is a string containing an integer in epoch milliseconds as explained further here: https://en.wikipedia.org/wiki/Unix_time

end

required

string

The timestamp specifying the end of the video you want to download. 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 start the video download for

Responses

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

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

Bad Request Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Authentication Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Unauthorized Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Resource Not Found Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Timeout Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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

Bad Gateway Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

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