Skip to content
Picogrid Legion

Get stream

Get stream

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

Get the stream specified by the id in the url path

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The id of the stream you want to target

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
terminal_id
required
string
fragment_type_id
required
string
processor_ids
required

The ids of the processors you have instantiated for your organization and attached to this stream. Picogrid offers several different types of processing for different data streams such as object detection on image/jpg type streams

Array<string>
last_edited
required

Epoch milliseconds integer. See https://en.wikipedia.org/wiki/Unix_time for more information

integer
compatible_namespaces
required

The namespaces compatible with this stream. Namespaces define the commands available for a stream. For instance, the FLIR namespace enables users to perform PTZ commands on a FLIR camera.

Array<string>
Examplegenerated
{
  "id": "example",
  "terminal_id": "example",
  "fragment_type_id": "example",
  "processor_ids": [
    "example"
  ],
  "last_edited": 1,
  "compatible_namespaces": [
    "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

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