Skip to content
Picogrid Legion

Create entity

Create entity

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/entities
curl --request POST \
  --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/entities?include_classification_vector=false&with_location_latest=false' \
  --header 'Content-Type: application/json' \
  --data '{ "affiliation": "FRIEND", "category": "DEVICE", "expires_at": "2029-12-31T23:59:59Z", "is_active": true, "metadata": { "ip_address": "192.168.1.150", "manufacturer": "Axis Communications", "model": "P1448-LE", "night_vision": true, "pan_tilt": true, "resolution": "4K", "weatherproof": true, "zoom_range": "12x optical" }, "name": "Axis IP Camera", "parent_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "status": "active", "type": "Camera" }'

Creates a new entity.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_classification_vector
boolean
with_location_latest
boolean

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
affiliation
string
Allowed values: PENDING UNKNOWN ASSUMED_FRIEND FRIEND NEUTRAL SUSPECT HOSTILE EXERCISE_PENDING EXERCISE_UNKNOWN EXERCISE_FRIEND EXERCISE_NEUTRAL EXERCISE_ASSUMED_FRIEND JOKER FAKER NONE_SPECIFIED
category
required
string
Allowed values: DEVICE DETECTION ALERT WEATHER GEOMETRIC ZONE SENSOR VEHICLE UXV TRACK
classification
object
key
additional properties
any
expires_at
string
is_active
boolean
metadata
object
key
additional properties
any
name
required
string
parent_id
string | null format: uuid
status
required
string
type
required
string
Example
{
  "affiliation": "FRIEND",
  "category": "DEVICE",
  "expires_at": "2029-12-31T23:59:59Z",
  "is_active": true,
  "metadata": {
    "ip_address": "192.168.1.150",
    "manufacturer": "Axis Communications",
    "model": "P1448-LE",
    "night_vision": true,
    "pan_tilt": true,
    "resolution": "4K",
    "weatherproof": true,
    "zoom_range": "12x optical"
  },
  "name": "Axis IP Camera",
  "parent_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "active",
  "type": "Camera"
}

Responses

Section titled “Responses”

200

Section titled “200”

Idempotent response

Media typeapplication/json
object
affiliation
required
string
Allowed values: PENDING UNKNOWN ASSUMED_FRIEND FRIEND NEUTRAL SUSPECT HOSTILE EXERCISE_PENDING EXERCISE_UNKNOWN EXERCISE_FRIEND EXERCISE_NEUTRAL EXERCISE_ASSUMED_FRIEND JOKER FAKER NONE_SPECIFIED
category
required
string
Allowed values: DEVICE DETECTION ALERT WEATHER GEOMETRIC ZONE SENSOR VEHICLE UXV TRACK
classification
object
key
additional properties
any
created_at
required
string
deleted_at
string
expires_at
string
id
required
string format: uuid
is_active
boolean
is_expired
required
boolean
location_latest
object
acceleration
Array<number>
angular_velocity
Array<number>
bearing
number
<= 360
covariance
Array<Array<number>>
created_at
required
string
crs
string
default: EPSG:4978
Allowed values: EPSG:4978 EPSG:4326 EPSG:4979
entity_id
required
string format: uuid
id
required
string format: uuid
orientation
Array<number>
>= 4 items <= 4 items
position
required
object
coordinates
required
Array<number>
type
required
string
/^(Point|LineString|Polygon)$/
radius
number
recorded_at
string
source
required
string
speed
number
velocity
Array<number>
metadata
object
key
additional properties
any
name
required
string
organization_id
required
string format: uuid
parent_id
required
string | null format: uuid
status
required
string
top_classification
string
top_classification_probability
number
type
required
string
updated_at
required
string
Example
{
  "affiliation": "FRIEND",
  "category": "DEVICE",
  "created_at": "2023-12-15T14:30:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "manufacturer": "General Atomics",
    "model": "MQ-9"
  },
  "name": "MQ-9 Reaper",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "parent_id": "456e8400-e29b-41d4-a716-446655440000",
  "status": "ACTIVE",
  "type": "DRONE",
  "updated_at": "2023-12-15T14:30:00Z"
}

201

Section titled “201”

Created

Media typeapplication/json
object
affiliation
required
string
Allowed values: PENDING UNKNOWN ASSUMED_FRIEND FRIEND NEUTRAL SUSPECT HOSTILE EXERCISE_PENDING EXERCISE_UNKNOWN EXERCISE_FRIEND EXERCISE_NEUTRAL EXERCISE_ASSUMED_FRIEND JOKER FAKER NONE_SPECIFIED
category
required
string
Allowed values: DEVICE DETECTION ALERT WEATHER GEOMETRIC ZONE SENSOR VEHICLE UXV TRACK
classification
object
key
additional properties
any
created_at
required
string
deleted_at
string
expires_at
string
id
required
string format: uuid
is_active
boolean
is_expired
required
boolean
location_latest
object
acceleration
Array<number>
angular_velocity
Array<number>
bearing
number
<= 360
covariance
Array<Array<number>>
created_at
required
string
crs
string
default: EPSG:4978
Allowed values: EPSG:4978 EPSG:4326 EPSG:4979
entity_id
required
string format: uuid
id
required
string format: uuid
orientation
Array<number>
>= 4 items <= 4 items
position
required
object
coordinates
required
Array<number>
type
required
string
/^(Point|LineString|Polygon)$/
radius
number
recorded_at
string
source
required
string
speed
number
velocity
Array<number>
metadata
object
key
additional properties
any
name
required
string
organization_id
required
string format: uuid
parent_id
required
string | null format: uuid
status
required
string
top_classification
string
top_classification_probability
number
type
required
string
updated_at
required
string
Example
{
  "affiliation": "FRIEND",
  "category": "DEVICE",
  "created_at": "2023-12-15T14:30:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "manufacturer": "General Atomics",
    "model": "MQ-9"
  },
  "name": "MQ-9 Reaper",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "parent_id": "456e8400-e29b-41d4-a716-446655440000",
  "status": "ACTIVE",
  "type": "DRONE",
  "updated_at": "2023-12-15T14:30: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