Skip to content
Picogrid Legion

Create video stream

Create video stream

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/video
curl --request POST \
  --url https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/video \
  --header 'Content-Type: application/json' \
  --data '{ "entity_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef", "metadata": { "camera_type": "PTZ", "frame_rate": 30, "night_vision": true, "resolution": "1920x1080" }, "protocol": "RTMP", "stream_name": "drone_primary_feed" }'

Creates a new video stream associated with an entity

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
entity_id
required
string format: uuid
metadata
object
protocol
required
string
Allowed values: rtsp rtmp hls webrtc srt
stream_name
required
string
Example
{
  "entity_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
  "metadata": {
    "camera_type": "PTZ",
    "frame_rate": 30,
    "night_vision": true,
    "resolution": "1920x1080"
  },
  "protocol": "RTMP",
  "stream_name": "drone_primary_feed"
}

Responses

Section titled “Responses”

200

Section titled “200”

Idempotent response

Media typeapplication/json
object
created_at
required
string
entity_id
required
string format: uuid
has_recordings
required
boolean
id
required
string format: uuid
is_active
required
boolean
last_recording_at
string
metadata
object
organization_id
required
string format: uuid
playback_endpoints
object
key
additional properties
string
playback_url
string
protocol
required
string
Allowed values: rtsp rtmp hls webrtc srt
publish_url
string
stream_name
required
string
updated_at
required
string
Example
{
  "created_at": "2024-01-15T11:00:00Z",
  "entity_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
  "has_recordings": true,
  "is_active": true,
  "last_recording_at": "2024-03-11T16:00:00Z",
  "metadata": {
    "camera_type": "PTZ",
    "frame_rate": 30,
    "night_vision": true,
    "zoom_level": "10x"
  },
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "protocol": "rtsp",
  "stream_name": "drone_primary_feed",
  "updated_at": "2024-03-11T16:00:00Z"
}

201

Section titled “201”

Created

Media typeapplication/json
object
created_at
required
string
entity_id
required
string format: uuid
has_recordings
required
boolean
id
required
string format: uuid
is_active
required
boolean
last_recording_at
string
metadata
object
organization_id
required
string format: uuid
playback_endpoints
object
key
additional properties
string
playback_url
string
protocol
required
string
Allowed values: rtsp rtmp hls webrtc srt
publish_url
string
stream_name
required
string
updated_at
required
string
Example
{
  "created_at": "2024-01-15T11:00:00Z",
  "entity_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
  "has_recordings": true,
  "is_active": true,
  "last_recording_at": "2024-03-11T16:00:00Z",
  "metadata": {
    "camera_type": "PTZ",
    "frame_rate": 30,
    "night_vision": true,
    "zoom_level": "10x"
  },
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "protocol": "rtsp",
  "stream_name": "drone_primary_feed",
  "updated_at": "2024-03-11T16:00:00Z"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 400,
  "details": [
    {
      "Field": "organization_id",
      "Issue": "must be a valid UUID format"
    }
  ],
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 401,
  "details": [
    {
      "Field": "authorization_header",
      "Issue": "Bearer token is expired or malformed"
    }
  ],
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 403,
  "details": [
    {
      "Field": "required_scope",
      "Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'"
    }
  ],
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 409,
  "details": [
    {
      "field": "email",
      "issue": "must be a valid email address"
    }
  ],
  "message": "Request conflicts with current state of the resource",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 422,
  "details": [
    {
      "field": "email",
      "issue": "must be a valid email address"
    }
  ],
  "message": "Request data is well-formed but violates business rules",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
category
required

The category of the error

string
code
required

The HTTP status code

number
details

Additional details about the error

Array<object>
object
field

The field that caused the error

string
issue

The specific issue with the field

string
message
required

A human-readable error message

string
status
required

The status of the response, always ‘error’ for error responses

string
timestamp
required

The timestamp when the error occurred

string format: date-time
trace_id
required

A unique identifier for tracing the error

string format: uuid
Example
{
  "category": "server_error",
  "code": 500,
  "details": [
    {
      "field": "field_name",
      "issue": "Field validation issue"
    }
  ],
  "message": "Internal Server Error",
  "status": "error",
  "timestamp": "2024-03-15T10:30:00Z",
  "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}

Version 3.14.0 · commit 0771262