Blue API Reference

Docs

REST reference for the Blue API.

128REST paths

213Schemas

159Operations

6Guide pages

REST API

Updated 8/25/2026, 2:44:05 AM

API Keys3 operations

GET/api/api-keys/Apikeyrouter.List Api Keys

List API keys with the actual key value redacted for security reasons.

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`array<ApiKey>`	No	Successful Response

Response body

200application/jsonarray<ApiKey>

Name	In	Type	Required	Description
`body`	body	`array<ApiKey>`	Yes	None
`body[].id`	body	`string`	Yes	None
`body[].created_at`	body	`string`	Yes	None
`body[].updated_at`	body	`string \| null`	Yes	None
`body[].deleted_at`	body	`string \| null`	Yes	None
`body[].user_id`	body	`string`	Yes	None
`body[].prefix`	body	`string`	No	None
`body[].suffix`	body	`string`	Yes	None
`body[].name`	body	`string`	Yes	None
`body[].scopes`	body	`array<AuthScope>`	Yes	None
`body[].device_id`	body	`string \| null`	No	None
`body[].expires_at`	body	`string`	Yes	None
`body[].last_used_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/api-keys/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/api-keys/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-06-01T00:00:00Z",
    "updated_at": "2026-06-01T00:00:00Z",
    "deleted_at": "2026-06-01T00:00:00Z",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "prefix": "sk-",
    "suffix": "string",
    "name": "string"
  }
]

POST/api/api-keys/Apikeyrouter.Create Api Key

Create a new api key and returns it in full.

Parameters

Name	In	Type	Required	Description
`user_id`	body	`string \| null`	No	None
`prefix`	body	`string \| null`	No	None
`name`	body	`string \| null`	No	None
`scopes`	body	`array<AuthScope>`	No	None
`device_id`	body	`string \| null`	No	None
`time_to_live_seconds`	body	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`CreateApiKeyResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonCreateApiKeyResponse

Name	In	Type	Required	Description
`api_key`	body	`ApiKey`	Yes	Full API key model
`api_key.id`	body	`string`	Yes	None
`api_key.created_at`	body	`string`	Yes	None
`api_key.updated_at`	body	`string \| null`	Yes	None
`api_key.deleted_at`	body	`string \| null`	Yes	None
`api_key.user_id`	body	`string`	Yes	None
`api_key.prefix`	body	`string`	No	None
`api_key.suffix`	body	`string`	Yes	None
`api_key.name`	body	`string`	Yes	None
`api_key.scopes`	body	`array<AuthScope>`	Yes	None
`api_key.device_id`	body	`string \| null`	No	None
`api_key.expires_at`	body	`string`	Yes	None
`api_key.last_used_at`	body	`string \| null`	No	None
`raw_value`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/api-keys/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "prefix": "sk-",
  "name": "New API Key",
  "scopes": [
    "ARGUS"
  ],
  "device_id": "string",
  "time_to_live_seconds": 0
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/api-keys/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "user_id": "00000000-0000-0000-0000-000000000000",
        "prefix": "sk-",
        "name": "New API Key",
        "scopes": [
            "ARGUS"
        ],
        "device_id": "string",
        "time_to_live_seconds": 0
    },
)
print(response.json())

Example response

{
  "api_key": {
    "id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-06-01T00:00:00Z",
    "updated_at": "2026-06-01T00:00:00Z",
    "deleted_at": "2026-06-01T00:00:00Z",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "prefix": "sk-",
    "suffix": "string",
    "name": "string"
  },
  "raw_value": "string"
}

DELETE/api/api-keys/{api_key_id}Apikeyrouter.Delete Api Key

Delete an API key by its ID. Returns the deleted API key.

Parameters

Name	In	Type	Required	Description
`api_key_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ApiKey`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonApiKey

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`prefix`	body	`string`	No	None
`suffix`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`scopes`	body	`array<AuthScope>`	Yes	None
`device_id`	body	`string \| null`	No	None
`expires_at`	body	`string`	Yes	None
`last_used_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/api-keys/<api_key_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/api-keys/<api_key_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "prefix": "sk-",
  "suffix": "string",
  "name": "string"
}

Authentication3 operations

GET/api/auth/callbackAuthrouter.Browser Login Callback

Parameters

Name	In	Type	Required	Description
`code`	query	`string`	Yes	None
`state`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/auth/callback?code=<code>&state=<state>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/auth/callback",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/auth/loginAuthrouter.Begin Browser Login

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/auth/login" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/auth/login",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/auth/logoutAuthrouter.Logout

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/auth/logout" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/auth/logout",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

Blue Data Access2 operations

POST/api/auth/tile-sessionsCreate Tile Session

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`204`	response	`unknown`	No	Successful Response

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/auth/tile-sessions" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/auth/tile-sessions",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/data-access/collections/{collection_id}/displays/{display_id}/tilejsonCollection Tilejson

Resolve a stable catalog display identity to runtime TileJSON.

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None
`display_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/data-access/collections/<collection_id>/displays/<display_id>/tilejson" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/data-access/collections/<collection_id>/displays/<display_id>/tilejson",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

Blue Feature Creation1 operations

POST/api/maps/{map_id}/featuresCreate a map feature collection

Creates user-authored geographic content backed by a Blue map layer. Use the request body's `type` discriminator to choose one of the documented feature schemas, then read the result through the returned OGC API Features links.

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`body`	application/json	`BoundaryFeatureCreateRequest \| NamedAreaInterestFeatureCreateRequest \| AnnotationFeatureCreateRequest \| GeoJsonFeatureCreateRequest \| PositionAreaArtilleryFeatureCreateRequest \| LogisticReleasePointFeatureCreateRequest`	Yes	None

Request variants

Select a schema with the request body's type discriminator.

Name	In	Type	Required	Description
`boundary`	type discriminator	`BoundaryFeatureCreateRequest`	Yes	Create the map's area-of-operations boundary.
`named_area_interest`	type discriminator	`NamedAreaInterestFeatureCreateRequest`	Yes	Create a named rectangular area used by terrain and planning workflows.
`annotation`	type discriminator	`AnnotationFeatureCreateRequest`	Yes	Create user-authored point, line, or polygon map annotations.
`geojson`	type discriminator	`GeoJsonFeatureCreateRequest`	Yes	Create a general-purpose custom GeoJSON collection.
`position_area_artillery`	type discriminator	`PositionAreaArtilleryFeatureCreateRequest`	Yes	Create artillery position-area features used by planning workflows.
`logistic_release_point`	type discriminator	`LogisticReleasePointFeatureCreateRequest`	Yes	Create logistics release-point features used by planning workflows.

`boundary` example

{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            [
              [
                -93.1213,
                31.1275
              ],
              [
                -93.1207,
                31.089
              ],
              [
                -93.0442,
                31.088
              ],
              [
                -93.0439,
                31.1283
              ],
              [
                -93.1213,
                31.1275
              ]
            ]
          ],
          "type": "Polygon"
        },
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Area of Operations",
  "type": "boundary"
}

`named_area_interest` example

{
  "description": "Primary observation area",
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            [
              [
                -104.9,
                38.8
              ],
              [
                -104.7,
                38.8
              ],
              [
                -104.7,
                38.95
              ],
              [
                -104.9,
                38.95
              ],
              [
                -104.9,
                38.8
              ]
            ]
          ],
          "type": "Polygon"
        },
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Named Area of Interest 1",
  "type": "named_area_interest"
}

`annotation` example

{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            -104.8,
            38.88
          ],
          "type": "Point"
        },
        "properties": {
          "label": "Observation post"
        },
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Observation Notes",
  "type": "annotation"
}

`geojson` example

{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            -104.8,
            38.88
          ],
          "type": "Point"
        },
        "properties": {
          "source": "partner"
        },
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Partner Data",
  "type": "geojson"
}

`position_area_artillery` example

{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            [
              [
                -93.1213,
                31.1275
              ],
              [
                -93.1207,
                31.089
              ],
              [
                -93.0442,
                31.088
              ],
              [
                -93.0439,
                31.1283
              ],
              [
                -93.1213,
                31.1275
              ]
            ]
          ],
          "type": "Polygon"
        },
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Artillery Position Areas",
  "type": "position_area_artillery"
}

`logistic_release_point` example

{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            -104.8,
            38.88
          ],
          "type": "Point"
        },
        "properties": {
          "name": "LRP 1"
        },
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Logistic Release Points",
  "type": "logistic_release_point"
}

Responses

Name	In	Type	Required	Description
`201`	application/json	`CreateMapFeatureResponse`	No	The feature collection was created.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`Location`	201 header	`string`	No	Absolute URL of the created OGC feature collection.

Response body

201application/jsonCreateMapFeatureResponse

Name	In	Type	Required	Description
`map_layer_id`	body	`string`	Yes	Blue layer identifier backing this feature collection.
`collection_id`	body	`string`	Yes	OGC collection identifier, formatted as layer--{map_layer_id}.
`type`	body	`boundary \| named_area_interest \| annotation \| geojson \| position_area_artillery \| logistic_release_point`	Yes	Semantic feature type that was created.
`title`	body	`string`	Yes	Human-readable OGC collection title.
`feature_collection`	body	`GeoJsonFeatureCollection`	Yes	A GeoJSON FeatureCollection in CRS84 longitude/latitude coordinates.
`feature_collection.type`	body	`string`	Yes	GeoJSON object type. Feature creation always accepts a FeatureCollection.
`feature_collection.features`	body	`array<object>`	Yes	GeoJSON Feature objects in [longitude, latitude] coordinate order.
`links`	body	`array<MapFeatureLink>`	Yes	None
`links[].rel`	body	`collection \| items`	Yes	None
`links[].href`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/maps/<map_id>/features" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "feature_collection": {
    "features": [
      {
        "geometry": {
          "coordinates": [
            [
              [
                -93.1213,
                31.1275
              ],
              [
                -93.1207,
                31.089
              ],
              [
                -93.0442,
                31.088
              ],
              [
                -93.0439,
                31.1283
              ],
              [
                -93.1213,
                31.1275
              ]
            ]
          ],
          "type": "Polygon"
        },
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  },
  "title": "Area of Operations",
  "type": "boundary"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/maps/<map_id>/features",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "feature_collection": {
            "features": [
                {
                    "geometry": {
                        "coordinates": [
                            [
                                [
                                    -93.1213,
                                    31.1275
                                ],
                                [
                                    -93.1207,
                                    31.089
                                ],
                                [
                                    -93.0442,
                                    31.088
                                ],
                                [
                                    -93.0439,
                                    31.1283
                                ],
                                [
                                    -93.1213,
                                    31.1275
                                ]
                            ]
                        ],
                        "type": "Polygon"
                    },
                    "properties": {},
                    "type": "Feature"
                }
            ],
            "type": "FeatureCollection"
        },
        "title": "Area of Operations",
        "type": "boundary"
    },
)
print(response.json())

Example response

{
  "map_layer_id": "00000000-0000-0000-0000-000000000000",
  "collection_id": "string",
  "type": "boundary",
  "title": "string",
  "feature_collection": {
    "type": "string",
    "features": [
      {}
    ]
  },
  "links": [
    {
      "rel": "collection",
      "href": "string"
    }
  ]
}

Blue Layer Management10 operations

POST/api/maps/{map_id}/layer-imports/annotationsMaplayerrouter.Upload Annotation Layer

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`upload_file`	body	`string`	Yes	None
`name`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`BaseMapLayerSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonBaseMapLayerSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`layer_type`	body	`MapLayerType`	Yes	None
`availability`	body	`string`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/maps/<map_id>/layer-imports/annotations" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "upload_file": "string",
  "name": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layer-imports/annotations",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "upload_file": "string",
        "name": "string"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {}
}

POST/api/maps/{map_id}/layer-imports/flight-eventsMaplayerrouter.Upload Flight Events

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`upload_files`	body	`array<string>`	Yes	None
`name`	body	`string \| null`	No	None
`class_color_map`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`FlightEventImportResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonFlightEventImportResponse

Name	In	Type	Required	Description
`layer_id`	body	`string`	Yes	None
`imported_events`	body	`integer`	Yes	None
`imported_images`	body	`integer`	Yes	None
`skipped_events`	body	`integer`	Yes	None
`ignored_files`	body	`integer`	Yes	None
`warnings`	body	`array<FlightEventImportWarningResponse>`	Yes	None
`warnings[].file_name`	body	`string`	Yes	None
`warnings[].code`	body	`string`	Yes	None
`warnings[].message`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/maps/<map_id>/layer-imports/flight-events" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "upload_files": [
    "string"
  ],
  "name": "string",
  "class_color_map": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layer-imports/flight-events",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "upload_files": [
            "string"
        ],
        "name": "string",
        "class_color_map": "string"
    },
)
print(response.json())

Example response

{
  "layer_id": "00000000-0000-0000-0000-000000000000",
  "imported_events": 0,
  "imported_images": 0,
  "skipped_events": 0,
  "ignored_files": 0,
  "warnings": [
    {
      "file_name": "string",
      "code": "string",
      "message": "string"
    }
  ]
}

GET/api/maps/{map_id}/layer-presentationMaplayerpresentationrouter.Get Layer Presentation

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`LayerPresentation`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonLayerPresentation

Name	In	Type	Required	Description
`schemaVersion`	body	`integer`	No	None
`sections`	body	`object`	No	None
`sections.{key}`	body	`LayerSectionPresentation`	No	None
`sections.{key}.collapsed`	body	`boolean`	Yes	None
`sections.{key}.order`	body	`array<string>`	Yes	None
`nodes`	body	`object`	No	None
`nodes.{key}`	body	`LayerNodePresentation`	No	None
`nodes.{key}.visible`	body	`boolean`	Yes	None
`nodes.{key}.expanded`	body	`boolean`	Yes	None
`nodes.{key}.opacity`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/layer-presentation" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layer-presentation",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "schemaVersion": 1,
  "sections": {},
  "nodes": {}
}

PUT/api/maps/{map_id}/layer-presentationMaplayerpresentationrouter.Put Layer Presentation

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`schemaVersion`	body	`integer`	No	None
`sections`	body	`object`	No	None
`nodes`	body	`object`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`LayerPresentation`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonLayerPresentation

Name	In	Type	Required	Description
`schemaVersion`	body	`integer`	No	None
`sections`	body	`object`	No	None
`sections.{key}`	body	`LayerSectionPresentation`	No	None
`sections.{key}.collapsed`	body	`boolean`	Yes	None
`sections.{key}.order`	body	`array<string>`	Yes	None
`nodes`	body	`object`	No	None
`nodes.{key}`	body	`LayerNodePresentation`	No	None
`nodes.{key}.visible`	body	`boolean`	Yes	None
`nodes.{key}.expanded`	body	`boolean`	Yes	None
`nodes.{key}.opacity`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/maps/<map_id>/layer-presentation" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "schemaVersion": 1,
  "sections": {},
  "nodes": {}
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layer-presentation",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "schemaVersion": 1,
        "sections": {},
        "nodes": {}
    },
)
print(response.json())

Example response

{
  "schemaVersion": 1,
  "sections": {},
  "nodes": {}
}

GET/api/maps/{map_id}/layersMaplayerrouter.Get Map Layers

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`layer_type`	query	`MapLayerType \| null`	No	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListMapLayerResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListMapLayerResponse

Name	In	Type	Required	Description
`map_layers`	body	`array<BaseMapLayerSchema>`	Yes	None
`map_layers[].id`	body	`string`	Yes	None
`map_layers[].created_at`	body	`string`	Yes	None
`map_layers[].updated_at`	body	`string \| null`	Yes	None
`map_layers[].deleted_at`	body	`string \| null`	Yes	None
`map_layers[].user_id`	body	`string`	Yes	None
`map_layers[].map_id`	body	`string`	Yes	None
`map_layers[].name`	body	`string`	Yes	None
`map_layers[].json_data`	body	`object \| string \| null`	Yes	None
`map_layers[].layer_type`	body	`MapLayerType`	Yes	None
`map_layers[].availability`	body	`string`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/layers?layer_type=<layer_type>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "map_layers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-01T00:00:00Z",
      "updated_at": {},
      "deleted_at": {},
      "user_id": "00000000-0000-0000-0000-000000000000",
      "map_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "json_data": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/maps/{map_id}/layersMaplayerrouter.Create Layer

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`name`	body	`string`	No	None
`layer_type`	body	`MapLayerType`	No	None
`json_data`	body	`object \| null`	No	None
`extra_data`	body	`object \| null`	No	None

Responses

Name	In	Type	Required	Description
`201`	application/json	`BaseMapLayerSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

201application/jsonBaseMapLayerSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`layer_type`	body	`MapLayerType`	Yes	None
`availability`	body	`string`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/maps/<map_id>/layers" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "untitled",
  "layer_type": "none",
  "json_data": {},
  "extra_data": {}
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "untitled",
        "layer_type": "none",
        "json_data": {},
        "extra_data": {}
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {}
}

GET/api/maps/{map_id}/layers/{layer_id}Maplayerrouter.Get Map Layer

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`layer_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`BaseMapLayerSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonBaseMapLayerSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`layer_type`	body	`MapLayerType`	Yes	None
`availability`	body	`string`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {}
}

PATCH/api/maps/{map_id}/layers/{layer_id}Maplayerrouter.Update Map Layer

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`layer_id`	path	`string`	Yes	None
`name`	body	`string \| null`	No	None
`layer_type`	body	`MapLayerType \| null`	No	None
`json_data`	body	`object \| null`	No	None
`extra_data`	body	`object \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`BaseMapLayerSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonBaseMapLayerSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`layer_type`	body	`MapLayerType`	Yes	None
`availability`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PATCH "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "layer_type": "none",
  "json_data": {},
  "extra_data": {}
}'

Python

import requests

response = requests.patch(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string",
        "layer_type": "none",
        "json_data": {},
        "extra_data": {}
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {}
}

DELETE/api/maps/{map_id}/layers/{layer_id}Maplayerrouter.Delete Map Layer

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`layer_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`204`	response	`unknown`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/layers/{layer_id}/flight-events/{event_id}/image-urlMaplayerrouter.Get Flight Event Image Url

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`layer_id`	path	`string`	Yes	None
`event_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`FlightEventImageUrlResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonFlightEventImageUrlResponse

Name	In	Type	Required	Description
`url`	body	`string`	Yes	None
`expires_in_seconds`	body	`integer`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>/flight-events/<event_id>/image-url" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/layers/<layer_id>/flight-events/<event_id>/image-url",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "url": "string",
  "expires_in_seconds": 0
}

Documents4 operations

POST/api/documents/Documentrouter.Upload Documents

Parameters

Name	In	Type	Required	Description
`files`	body	`array<string>`	Yes	None
`operation_id`	body	`string`	Yes	None
`type`	body	`DocumentType`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListDocumentResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListDocumentResponse

Name	In	Type	Required	Description
`documents`	body	`array<DocumentResponse>`	Yes	None
`documents[].id`	body	`string`	Yes	None
`documents[].operation_id`	body	`string`	Yes	None
`documents[].name`	body	`string`	Yes	None
`documents[].type`	body	`DocumentType`	Yes	None
`documents[].file_type`	body	`string`	Yes	None
`documents[].size`	body	`integer`	Yes	None
`documents[].path`	body	`string`	Yes	None
`documents[].num_tokens`	body	`integer`	Yes	None
`documents[].status`	body	`DocumentStatus \| null`	Yes	None
`documents[].created_at`	body	`string \| null`	No	None
`documents[].updated_at`	body	`string \| null`	No	None
`documents[].opened_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/documents/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "files": [
    "string"
  ],
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "type": "initial"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/documents/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "files": [
            "string"
        ],
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "type": "initial"
    },
)
print(response.json())

Example response

{
  "documents": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "type": "initial",
      "file_type": "string",
      "size": 0,
      "path": "string",
      "num_tokens": 0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/documents/Documentrouter.Get Documents

Parameters

Name	In	Type	Required	Description
`operation_id`	query	`string`	Yes	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListDocumentResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListDocumentResponse

Name	In	Type	Required	Description
`documents`	body	`array<DocumentResponse>`	Yes	None
`documents[].id`	body	`string`	Yes	None
`documents[].operation_id`	body	`string`	Yes	None
`documents[].name`	body	`string`	Yes	None
`documents[].type`	body	`DocumentType`	Yes	None
`documents[].file_type`	body	`string`	Yes	None
`documents[].size`	body	`integer`	Yes	None
`documents[].path`	body	`string`	Yes	None
`documents[].num_tokens`	body	`integer`	Yes	None
`documents[].status`	body	`DocumentStatus \| null`	Yes	None
`documents[].created_at`	body	`string \| null`	No	None
`documents[].updated_at`	body	`string \| null`	No	None
`documents[].opened_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/documents/?operation_id=<operation_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/documents/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "documents": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "type": "initial",
      "file_type": "string",
      "size": 0,
      "path": "string",
      "num_tokens": 0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

DELETE/api/documents/{document_id}Documentrouter.Delete Document

Parameters

Name	In	Type	Required	Description
`document_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`DocumentResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonDocumentResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`type`	body	`DocumentType`	Yes	None
`file_type`	body	`string`	Yes	None
`size`	body	`integer`	Yes	None
`path`	body	`string`	Yes	None
`num_tokens`	body	`integer`	Yes	None
`status`	body	`DocumentStatus \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None
`opened_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/documents/<document_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/documents/<document_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "type": "initial",
  "file_type": "string",
  "size": 0,
  "path": "string",
  "num_tokens": 0
}

GET/api/documents/{document_id}/presigned-urlDocumentrouter.Presigned Url

Parameters

Name	In	Type	Required	Description
`document_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`string`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonstring

Name	In	Type	Required	Description
`body`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/documents/<document_id>/presigned-url" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/documents/<document_id>/presigned-url",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

"string"

Entities6 operations

GET/api/operations/{operation_id}/entities/List operation entities

Lists active entities in the operation. Send If-None-Match with a prior ETag to receive 304 when unchanged.

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`if-none-match`	header	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`EntityListResponse`	No	Successful Response
`304`	response	`unknown`	No	The operation entity roster has not changed.
`403`	response	`unknown`	No	Operation access was denied or the API key lacks the ENTITIES scope.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`ETag`	200 header	`string`	No	Validator derived from entity IDs and revisions.

Response body

200application/jsonEntityListResponse

Name	In	Type	Required	Description
`entities`	body	`array<EntityResponse>`	Yes	None
`entities[].id`	body	`string`	Yes	None
`entities[].operation_id`	body	`string`	Yes	None
`entities[].revision`	body	`integer`	Yes	None
`entities[].profile`	body	`EntityProfile-Output`	Yes	None
`entities[].current_state`	body	`EntityCurrentState-Output \| null`	No	None
`entities[].metadata`	body	`object`	Yes	None
`entities[].created_at`	body	`string`	Yes	None
`entities[].updated_at`	body	`string \| null`	No	None
`entities[].deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "revision": 0,
      "profile": {
        "unit_name": {},
        "sidc": {},
        "description": {},
        "affiliation": {},
        "higher_hq": {},
        "support_priority": {},
        "capabilities": {}
      },
      "current_state": {},
      "metadata": {},
      "created_at": "2026-06-01T00:00:00Z",
      "updated_at": {}
    }
  ]
}

POST/api/operations/{operation_id}/entities/Create an operation entity

Creates a typed operation entity. Known radio catalog defaults are completed and stored by the server.

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`profile`	body	`EntityProfile-Input`	Yes	None
`current_state`	body	`EntityCurrentState-Input \| null`	No	None
`metadata`	body	`object`	No	None

Responses

Name	In	Type	Required	Description
`201`	application/json	`EntityResponse`	No	Successful Response
`403`	response	`unknown`	No	Operation access was denied or the API key lacks the ENTITIES scope.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`ETag`	201 header	`string`	No	Validator for the created entity revision.

Response body

201application/jsonEntityResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`revision`	body	`integer`	Yes	None
`profile`	body	`EntityProfile-Output`	Yes	None
`profile.unit_name`	body	`string`	Yes	Human-readable unit or entity name.
`profile.sidc`	body	`string`	Yes	MIL-STD-2525 symbol identification code.
`profile.description`	body	`string \| null`	No	Free-text entity description.
`profile.affiliation`	body	`friendly \| hostile \| neutral \| unknown \| null`	No	Operational affiliation used by map styling and planning.
`profile.higher_hq`	body	`string \| null`	No	Name or identifier of the parent headquarters.
`profile.support_priority`	body	`integer \| null`	No	Relative support priority; lower positive numbers represent higher priority.
`profile.capabilities`	body	`array<PersonnelCapability \| EffectivenessPowerCapability \| GroundMobilityCapability-Output \| RadarCapability \| NonRadarSensorCapability \| ArtilleryCapability \| UASCapability \| CounterUASCapability \| OrbitalLaunchCapability \| GeneratorCapability \| RadioCapability-Output \| SuppliesCapability-Output \| MedicalRosterCapability-Output>`	No	Typed optional behaviors and domain data attached to this entity. Capability IDs must be stable and unique. Unknown models are accepted, but capability types and fields must match the documented schema.
`current_state`	body	`EntityCurrentState-Output \| null`	No	None
`current_state.observed_at`	body	`string \| null`	No	Time this state was observed; defaults to server receipt time when omitted.
`current_state.location`	body	`GeoJSONPoint \| GeoJSONPointFeature \| null`	No	Canonical GeoJSON location using [longitude, latitude] coordinate order.
`current_state.location.type`	body	`string`	No	None
`current_state.location.coordinates`	body	`array<unknown>`	Yes	GeoJSON coordinate pair in [longitude, latitude] order.
`current_state.stats`	body	`OperationalStats`	No	None
`current_state.stats.readiness`	body	`number`	No	Readiness fraction from 0 to 1.
`current_state.stats.equipment_condition`	body	`number`	No	Equipment-condition fraction from 0 to 1.
`current_state.stats.ammunition`	body	`number`	No	Ammunition fraction from 0 to 1.
`current_state.stats.fatigue`	body	`number`	No	Fatigue fraction from 0 to 1.
`current_state.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	Typed changing state for capabilities referenced by capability_id.
`metadata`	body	`object`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None
`deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "current_state": {
    "capability_states": [],
    "location": {
      "coordinates": [
        -120.5752,
        45.9037
      ],
      "type": "Point"
    },
    "stats": {
      "ammunition": 1,
      "equipment_condition": 1,
      "fatigue": 0,
      "readiness": 1
    }
  },
  "metadata": {
    "source": "maven"
  },
  "profile": {
    "affiliation": "friendly",
    "capabilities": [
      {
        "config": {
          "antenna": {
            "model": "AS3900A"
          },
          "network_name": "command",
          "operating_frequency_mhz": 40,
          "selected_power_level_id": "HI"
        },
        "id": "radio-1",
        "model": "RT1523_ASIP",
        "schema_version": 1,
        "type": "communications.radio"
      }
    ],
    "sidc": "10031000211211000000",
    "unit_name": "11 ABN"
  }
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "current_state": {
            "capability_states": [],
            "location": {
                "coordinates": [
                    -120.5752,
                    45.9037
                ],
                "type": "Point"
            },
            "stats": {
                "ammunition": 1,
                "equipment_condition": 1,
                "fatigue": 0,
                "readiness": 1
            }
        },
        "metadata": {
            "source": "maven"
        },
        "profile": {
            "affiliation": "friendly",
            "capabilities": [
                {
                    "config": {
                        "antenna": {
                            "model": "AS3900A"
                        },
                        "network_name": "command",
                        "operating_frequency_mhz": 40,
                        "selected_power_level_id": "HI"
                    },
                    "id": "radio-1",
                    "model": "RT1523_ASIP",
                    "schema_version": 1,
                    "type": "communications.radio"
                }
            ],
            "sidc": "10031000211211000000",
            "unit_name": "11 ABN"
        }
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "revision": 0,
  "profile": {
    "unit_name": "string",
    "sidc": "string",
    "description": "string",
    "affiliation": "friendly",
    "higher_hq": "string",
    "support_priority": 0,
    "capabilities": [
      {
        "config": {
          "total": 90
        },
        "id": "personnel-1",
        "model": "Assigned strength",
        "schema_version": 1,
        "type": "organization.personnel"
      },
      {
        "config": {
          "value": 33.45
        },
        "id": "power-1",
        "model": "Operational estimate",
        "schema_version": 1,
        "type": "effectiveness.power"
      },
      {
        "config": {
          "total_capacity_gallons": 1323,
          "vehicles": [
            {
              "cross_country_gallons_per_hour": 11,
              "cross_country_speed_kph": 24,
              "fuel_capacity_gallons": 63,
              "idle_gallons_per_hour": 1.2,
              "max_load_kg": 1800,
              "model": "CUSTOM-WHEELED",
              "movement_type": "Wheeled",
              "primary_road_gallons_per_hour": 6.5,
              "primary_road_speed_kph": 72,
              "quantity": 21,
              "secondary_road_gallons_per_hour": 8,
              "secondary_road_speed_kph": 48
            }
          ]
        },
        "id": "ground-mobility-1",
        "model": "CUSTOM-WHEELED-PLATOON",
        "schema_version": 1,
        "type": "mobility.ground"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 120,
          "range_km": 42
        },
        "id": "radar-1",
        "model": "CUSTOM-RADAR-X",
        "schema_version": 1,
        "type": "sensor.radar"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 70,
          "range_km": 18
        },
        "id": "sensor-1",
        "model": "CUSTOM-EOIR-X",
        "schema_version": 1,
        "type": "sensor.non_radar"
      },
      {
        "config": {
          "max_range_meters": 24000
        },
        "id": "artillery-1",
        "model": "CUSTOM-HOWITZER-X",
        "schema_version": 1,
        "type": "fires.artillery"
      },
      {
        "config": {
          "max_range_km": 180,
          "max_speed_kph": 130
        },
        "id": "uas-1",
        "model": "CUSTOM-UAS-X",
        "schema_version": 1,
        "type": "aviation.uas"
      },
      {
        "config": {
          "directional": false,
          "field_of_view_degrees": 360,
          "range_km": 12
        },
        "id": "counter-uas-1",
        "model": "CUSTOM-CUAS-X",
        "schema_version": 1,
        "type": "defense.counter_uas"
      },
      {
        "config": {
          "classification": "Small launch vehicle",
          "debris_dispersion_radius_ft": 10000,
          "inhabited_building_distance_ft": 5000,
          "public_traffic_route_distance_ft": 3000
        },
        "id": "orbital-launch-1",
        "model": "CUSTOM-LAUNCH-X",
        "schema_version": 1,
        "type": "launch.orbital"
      },
      {
        "config": {
          "fuel_consumption_gallons_per_hour": 2.5,
          "fuel_type": "JP-8"
        },
        "id": "generator-1",
        "model": "CUSTOM-GENERATOR-X",
        "schema_version": 1,
        "type": "power.generator"
      },
      {
        "config": {
          "antenna": {
            "default_height_ft": 10,
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "height_override_ft": 30,
            "mast_model": "CUSTOM-MAST-X",
            "mast_supported": true,
            "model": "CUSTOM-ANTENNA-X"
          },
          "frequency_bands": [
            {
              "maximum_mhz": 400,
              "minimum_mhz": 225
            }
          ],
          "network_name": "command",
          "operating_frequency_mhz": 300,
          "power_levels": [
            {
              "data_expected_range_km": 20,
              "expected_range_km": 35,
              "id": "high",
              "label": "High",
              "max_effective_range_km": {
                "maximum": 45,
                "minimum": 30
              },
              "planning_range_km": {
                "maximum": 35,
                "minimum": 25
              },
              "power_output_watts": 50
            }
          ],
          "requires_antenna": true,
          "selected_power_level_id": "high"
        },
        "id": "radio-1",
        "model": "CUSTOM-RADIO-X",
        "schema_version": 1,
        "type": "communications.radio"
      },
      {
        "config": {
          "items": [
            {
              "daily_allocation": 3,
              "id": "food-1",
              "initial_stock": 900,
              "measurement_unit": "Rations",
              "supply_type": "Food"
            },
            {
              "fuel_type": "JP-8",
              "id": "fuel-1",
              "initial_stock": 1200,
              "measurement_unit": "Gallons",
              "supply_type": "Fuel"
            },
            {
              "daily_allocation": 2,
              "id": "water-1",
              "initial_stock": 600,
              "measurement_unit": "Gallons",
              "supply_type": "Water"
            },
            {
              "id": "shelter-1",
              "initial_stock": 10,
              "measurement_unit": "Tents",
              "supply_type": "Shelter"
            }
          ]
        },
        "id": "supplies-1",
        "model": "Unit stocks",
        "schema_version": 1,
        "type": "sustainment.supplies"
      },
      {
        "config": {
          "patients": [
            {
              "id": "patient-1"
            }
          ]
        },
        "id": "medical-1",
        "model": "Patient roster",
        "schema_version": 1,
        "type": "medical.roster"
      }
    ]
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  },
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

GET/api/operations/{operation_id}/entities/{entity_id}Get an operation entity

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`if-none-match`	header	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`EntityResponse`	No	Successful Response
`304`	response	`unknown`	No	The entity revision has not changed.
`403`	response	`unknown`	No	Access denied.
`404`	response	`unknown`	No	Entity not found.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`ETag`	200 header	`string`	No	Validator for this entity revision.

Response body

200application/jsonEntityResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`revision`	body	`integer`	Yes	None
`profile`	body	`EntityProfile-Output`	Yes	None
`profile.unit_name`	body	`string`	Yes	Human-readable unit or entity name.
`profile.sidc`	body	`string`	Yes	MIL-STD-2525 symbol identification code.
`profile.description`	body	`string \| null`	No	Free-text entity description.
`profile.affiliation`	body	`friendly \| hostile \| neutral \| unknown \| null`	No	Operational affiliation used by map styling and planning.
`profile.higher_hq`	body	`string \| null`	No	Name or identifier of the parent headquarters.
`profile.support_priority`	body	`integer \| null`	No	Relative support priority; lower positive numbers represent higher priority.
`profile.capabilities`	body	`array<PersonnelCapability \| EffectivenessPowerCapability \| GroundMobilityCapability-Output \| RadarCapability \| NonRadarSensorCapability \| ArtilleryCapability \| UASCapability \| CounterUASCapability \| OrbitalLaunchCapability \| GeneratorCapability \| RadioCapability-Output \| SuppliesCapability-Output \| MedicalRosterCapability-Output>`	No	Typed optional behaviors and domain data attached to this entity. Capability IDs must be stable and unique. Unknown models are accepted, but capability types and fields must match the documented schema.
`current_state`	body	`EntityCurrentState-Output \| null`	No	None
`current_state.observed_at`	body	`string \| null`	No	Time this state was observed; defaults to server receipt time when omitted.
`current_state.location`	body	`GeoJSONPoint \| GeoJSONPointFeature \| null`	No	Canonical GeoJSON location using [longitude, latitude] coordinate order.
`current_state.location.type`	body	`string`	No	None
`current_state.location.coordinates`	body	`array<unknown>`	Yes	GeoJSON coordinate pair in [longitude, latitude] order.
`current_state.stats`	body	`OperationalStats`	No	None
`current_state.stats.readiness`	body	`number`	No	Readiness fraction from 0 to 1.
`current_state.stats.equipment_condition`	body	`number`	No	Equipment-condition fraction from 0 to 1.
`current_state.stats.ammunition`	body	`number`	No	Ammunition fraction from 0 to 1.
`current_state.stats.fatigue`	body	`number`	No	Fatigue fraction from 0 to 1.
`current_state.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	Typed changing state for capabilities referenced by capability_id.
`metadata`	body	`object`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None
`deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "revision": 0,
  "profile": {
    "unit_name": "string",
    "sidc": "string",
    "description": "string",
    "affiliation": "friendly",
    "higher_hq": "string",
    "support_priority": 0,
    "capabilities": [
      {
        "config": {
          "total": 90
        },
        "id": "personnel-1",
        "model": "Assigned strength",
        "schema_version": 1,
        "type": "organization.personnel"
      },
      {
        "config": {
          "value": 33.45
        },
        "id": "power-1",
        "model": "Operational estimate",
        "schema_version": 1,
        "type": "effectiveness.power"
      },
      {
        "config": {
          "total_capacity_gallons": 1323,
          "vehicles": [
            {
              "cross_country_gallons_per_hour": 11,
              "cross_country_speed_kph": 24,
              "fuel_capacity_gallons": 63,
              "idle_gallons_per_hour": 1.2,
              "max_load_kg": 1800,
              "model": "CUSTOM-WHEELED",
              "movement_type": "Wheeled",
              "primary_road_gallons_per_hour": 6.5,
              "primary_road_speed_kph": 72,
              "quantity": 21,
              "secondary_road_gallons_per_hour": 8,
              "secondary_road_speed_kph": 48
            }
          ]
        },
        "id": "ground-mobility-1",
        "model": "CUSTOM-WHEELED-PLATOON",
        "schema_version": 1,
        "type": "mobility.ground"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 120,
          "range_km": 42
        },
        "id": "radar-1",
        "model": "CUSTOM-RADAR-X",
        "schema_version": 1,
        "type": "sensor.radar"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 70,
          "range_km": 18
        },
        "id": "sensor-1",
        "model": "CUSTOM-EOIR-X",
        "schema_version": 1,
        "type": "sensor.non_radar"
      },
      {
        "config": {
          "max_range_meters": 24000
        },
        "id": "artillery-1",
        "model": "CUSTOM-HOWITZER-X",
        "schema_version": 1,
        "type": "fires.artillery"
      },
      {
        "config": {
          "max_range_km": 180,
          "max_speed_kph": 130
        },
        "id": "uas-1",
        "model": "CUSTOM-UAS-X",
        "schema_version": 1,
        "type": "aviation.uas"
      },
      {
        "config": {
          "directional": false,
          "field_of_view_degrees": 360,
          "range_km": 12
        },
        "id": "counter-uas-1",
        "model": "CUSTOM-CUAS-X",
        "schema_version": 1,
        "type": "defense.counter_uas"
      },
      {
        "config": {
          "classification": "Small launch vehicle",
          "debris_dispersion_radius_ft": 10000,
          "inhabited_building_distance_ft": 5000,
          "public_traffic_route_distance_ft": 3000
        },
        "id": "orbital-launch-1",
        "model": "CUSTOM-LAUNCH-X",
        "schema_version": 1,
        "type": "launch.orbital"
      },
      {
        "config": {
          "fuel_consumption_gallons_per_hour": 2.5,
          "fuel_type": "JP-8"
        },
        "id": "generator-1",
        "model": "CUSTOM-GENERATOR-X",
        "schema_version": 1,
        "type": "power.generator"
      },
      {
        "config": {
          "antenna": {
            "default_height_ft": 10,
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "height_override_ft": 30,
            "mast_model": "CUSTOM-MAST-X",
            "mast_supported": true,
            "model": "CUSTOM-ANTENNA-X"
          },
          "frequency_bands": [
            {
              "maximum_mhz": 400,
              "minimum_mhz": 225
            }
          ],
          "network_name": "command",
          "operating_frequency_mhz": 300,
          "power_levels": [
            {
              "data_expected_range_km": 20,
              "expected_range_km": 35,
              "id": "high",
              "label": "High",
              "max_effective_range_km": {
                "maximum": 45,
                "minimum": 30
              },
              "planning_range_km": {
                "maximum": 35,
                "minimum": 25
              },
              "power_output_watts": 50
            }
          ],
          "requires_antenna": true,
          "selected_power_level_id": "high"
        },
        "id": "radio-1",
        "model": "CUSTOM-RADIO-X",
        "schema_version": 1,
        "type": "communications.radio"
      },
      {
        "config": {
          "items": [
            {
              "daily_allocation": 3,
              "id": "food-1",
              "initial_stock": 900,
              "measurement_unit": "Rations",
              "supply_type": "Food"
            },
            {
              "fuel_type": "JP-8",
              "id": "fuel-1",
              "initial_stock": 1200,
              "measurement_unit": "Gallons",
              "supply_type": "Fuel"
            },
            {
              "daily_allocation": 2,
              "id": "water-1",
              "initial_stock": 600,
              "measurement_unit": "Gallons",
              "supply_type": "Water"
            },
            {
              "id": "shelter-1",
              "initial_stock": 10,
              "measurement_unit": "Tents",
              "supply_type": "Shelter"
            }
          ]
        },
        "id": "supplies-1",
        "model": "Unit stocks",
        "schema_version": 1,
        "type": "sustainment.supplies"
      },
      {
        "config": {
          "patients": [
            {
              "id": "patient-1"
            }
          ]
        },
        "id": "medical-1",
        "model": "Patient roster",
        "schema_version": 1,
        "type": "medical.roster"
      }
    ]
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  },
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

PUT/api/operations/{operation_id}/entities/{entity_id}Replace or restore an operation entity

Upserts the entity at the requested ID. Replacing an archived entity restores it.

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`profile`	body	`EntityProfile-Input`	Yes	None
`current_state`	body	`EntityCurrentState-Input \| null`	No	None
`metadata`	body	`object`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`EntityResponse`	No	Successful Response
`403`	response	`unknown`	No	Access denied.
`422`	response	`unknown`	No	Entity or capability data is invalid.

Response headers

Name	In	Type	Required	Description
`ETag`	200 header	`string`	No	Validator for the stored entity revision.

Response body

200application/jsonEntityResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`revision`	body	`integer`	Yes	None
`profile`	body	`EntityProfile-Output`	Yes	None
`profile.unit_name`	body	`string`	Yes	Human-readable unit or entity name.
`profile.sidc`	body	`string`	Yes	MIL-STD-2525 symbol identification code.
`profile.description`	body	`string \| null`	No	Free-text entity description.
`profile.affiliation`	body	`friendly \| hostile \| neutral \| unknown \| null`	No	Operational affiliation used by map styling and planning.
`profile.higher_hq`	body	`string \| null`	No	Name or identifier of the parent headquarters.
`profile.support_priority`	body	`integer \| null`	No	Relative support priority; lower positive numbers represent higher priority.
`profile.capabilities`	body	`array<PersonnelCapability \| EffectivenessPowerCapability \| GroundMobilityCapability-Output \| RadarCapability \| NonRadarSensorCapability \| ArtilleryCapability \| UASCapability \| CounterUASCapability \| OrbitalLaunchCapability \| GeneratorCapability \| RadioCapability-Output \| SuppliesCapability-Output \| MedicalRosterCapability-Output>`	No	Typed optional behaviors and domain data attached to this entity. Capability IDs must be stable and unique. Unknown models are accepted, but capability types and fields must match the documented schema.
`current_state`	body	`EntityCurrentState-Output \| null`	No	None
`current_state.observed_at`	body	`string \| null`	No	Time this state was observed; defaults to server receipt time when omitted.
`current_state.location`	body	`GeoJSONPoint \| GeoJSONPointFeature \| null`	No	Canonical GeoJSON location using [longitude, latitude] coordinate order.
`current_state.location.type`	body	`string`	No	None
`current_state.location.coordinates`	body	`array<unknown>`	Yes	GeoJSON coordinate pair in [longitude, latitude] order.
`current_state.stats`	body	`OperationalStats`	No	None
`current_state.stats.readiness`	body	`number`	No	Readiness fraction from 0 to 1.
`current_state.stats.equipment_condition`	body	`number`	No	Equipment-condition fraction from 0 to 1.
`current_state.stats.ammunition`	body	`number`	No	Ammunition fraction from 0 to 1.
`current_state.stats.fatigue`	body	`number`	No	Fatigue fraction from 0 to 1.
`current_state.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	Typed changing state for capabilities referenced by capability_id.
`metadata`	body	`object`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None
`deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "current_state": {
    "capability_states": [],
    "location": {
      "coordinates": [
        -120.5752,
        45.9037
      ],
      "type": "Point"
    },
    "stats": {
      "ammunition": 1,
      "equipment_condition": 1,
      "fatigue": 0,
      "readiness": 1
    }
  },
  "metadata": {
    "source": "maven"
  },
  "profile": {
    "affiliation": "friendly",
    "capabilities": [
      {
        "config": {
          "antenna": {
            "model": "AS3900A"
          },
          "network_name": "command",
          "operating_frequency_mhz": 40,
          "selected_power_level_id": "HI"
        },
        "id": "radio-1",
        "model": "RT1523_ASIP",
        "schema_version": 1,
        "type": "communications.radio"
      }
    ],
    "sidc": "10031000211211000000",
    "unit_name": "11 ABN"
  }
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "current_state": {
            "capability_states": [],
            "location": {
                "coordinates": [
                    -120.5752,
                    45.9037
                ],
                "type": "Point"
            },
            "stats": {
                "ammunition": 1,
                "equipment_condition": 1,
                "fatigue": 0,
                "readiness": 1
            }
        },
        "metadata": {
            "source": "maven"
        },
        "profile": {
            "affiliation": "friendly",
            "capabilities": [
                {
                    "config": {
                        "antenna": {
                            "model": "AS3900A"
                        },
                        "network_name": "command",
                        "operating_frequency_mhz": 40,
                        "selected_power_level_id": "HI"
                    },
                    "id": "radio-1",
                    "model": "RT1523_ASIP",
                    "schema_version": 1,
                    "type": "communications.radio"
                }
            ],
            "sidc": "10031000211211000000",
            "unit_name": "11 ABN"
        }
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "revision": 0,
  "profile": {
    "unit_name": "string",
    "sidc": "string",
    "description": "string",
    "affiliation": "friendly",
    "higher_hq": "string",
    "support_priority": 0,
    "capabilities": [
      {
        "config": {
          "total": 90
        },
        "id": "personnel-1",
        "model": "Assigned strength",
        "schema_version": 1,
        "type": "organization.personnel"
      },
      {
        "config": {
          "value": 33.45
        },
        "id": "power-1",
        "model": "Operational estimate",
        "schema_version": 1,
        "type": "effectiveness.power"
      },
      {
        "config": {
          "total_capacity_gallons": 1323,
          "vehicles": [
            {
              "cross_country_gallons_per_hour": 11,
              "cross_country_speed_kph": 24,
              "fuel_capacity_gallons": 63,
              "idle_gallons_per_hour": 1.2,
              "max_load_kg": 1800,
              "model": "CUSTOM-WHEELED",
              "movement_type": "Wheeled",
              "primary_road_gallons_per_hour": 6.5,
              "primary_road_speed_kph": 72,
              "quantity": 21,
              "secondary_road_gallons_per_hour": 8,
              "secondary_road_speed_kph": 48
            }
          ]
        },
        "id": "ground-mobility-1",
        "model": "CUSTOM-WHEELED-PLATOON",
        "schema_version": 1,
        "type": "mobility.ground"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 120,
          "range_km": 42
        },
        "id": "radar-1",
        "model": "CUSTOM-RADAR-X",
        "schema_version": 1,
        "type": "sensor.radar"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 70,
          "range_km": 18
        },
        "id": "sensor-1",
        "model": "CUSTOM-EOIR-X",
        "schema_version": 1,
        "type": "sensor.non_radar"
      },
      {
        "config": {
          "max_range_meters": 24000
        },
        "id": "artillery-1",
        "model": "CUSTOM-HOWITZER-X",
        "schema_version": 1,
        "type": "fires.artillery"
      },
      {
        "config": {
          "max_range_km": 180,
          "max_speed_kph": 130
        },
        "id": "uas-1",
        "model": "CUSTOM-UAS-X",
        "schema_version": 1,
        "type": "aviation.uas"
      },
      {
        "config": {
          "directional": false,
          "field_of_view_degrees": 360,
          "range_km": 12
        },
        "id": "counter-uas-1",
        "model": "CUSTOM-CUAS-X",
        "schema_version": 1,
        "type": "defense.counter_uas"
      },
      {
        "config": {
          "classification": "Small launch vehicle",
          "debris_dispersion_radius_ft": 10000,
          "inhabited_building_distance_ft": 5000,
          "public_traffic_route_distance_ft": 3000
        },
        "id": "orbital-launch-1",
        "model": "CUSTOM-LAUNCH-X",
        "schema_version": 1,
        "type": "launch.orbital"
      },
      {
        "config": {
          "fuel_consumption_gallons_per_hour": 2.5,
          "fuel_type": "JP-8"
        },
        "id": "generator-1",
        "model": "CUSTOM-GENERATOR-X",
        "schema_version": 1,
        "type": "power.generator"
      },
      {
        "config": {
          "antenna": {
            "default_height_ft": 10,
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "height_override_ft": 30,
            "mast_model": "CUSTOM-MAST-X",
            "mast_supported": true,
            "model": "CUSTOM-ANTENNA-X"
          },
          "frequency_bands": [
            {
              "maximum_mhz": 400,
              "minimum_mhz": 225
            }
          ],
          "network_name": "command",
          "operating_frequency_mhz": 300,
          "power_levels": [
            {
              "data_expected_range_km": 20,
              "expected_range_km": 35,
              "id": "high",
              "label": "High",
              "max_effective_range_km": {
                "maximum": 45,
                "minimum": 30
              },
              "planning_range_km": {
                "maximum": 35,
                "minimum": 25
              },
              "power_output_watts": 50
            }
          ],
          "requires_antenna": true,
          "selected_power_level_id": "high"
        },
        "id": "radio-1",
        "model": "CUSTOM-RADIO-X",
        "schema_version": 1,
        "type": "communications.radio"
      },
      {
        "config": {
          "items": [
            {
              "daily_allocation": 3,
              "id": "food-1",
              "initial_stock": 900,
              "measurement_unit": "Rations",
              "supply_type": "Food"
            },
            {
              "fuel_type": "JP-8",
              "id": "fuel-1",
              "initial_stock": 1200,
              "measurement_unit": "Gallons",
              "supply_type": "Fuel"
            },
            {
              "daily_allocation": 2,
              "id": "water-1",
              "initial_stock": 600,
              "measurement_unit": "Gallons",
              "supply_type": "Water"
            },
            {
              "id": "shelter-1",
              "initial_stock": 10,
              "measurement_unit": "Tents",
              "supply_type": "Shelter"
            }
          ]
        },
        "id": "supplies-1",
        "model": "Unit stocks",
        "schema_version": 1,
        "type": "sustainment.supplies"
      },
      {
        "config": {
          "patients": [
            {
              "id": "patient-1"
            }
          ]
        },
        "id": "medical-1",
        "model": "Patient roster",
        "schema_version": 1,
        "type": "medical.roster"
      }
    ]
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  },
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

PATCH/api/operations/{operation_id}/entities/{entity_id}Patch an operation entity

Deep-merges objects, replaces arrays, and replaces metadata when metadata is supplied.

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`profile`	body	`EntityProfilePatch \| null`	No	None
`current_state`	body	`EntityCurrentStatePatch \| null`	No	None
`metadata`	body	`object \| null`	No	None
`expected_revision`	body	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`EntityResponse`	No	Successful Response
`403`	response	`unknown`	No	Access denied.
`404`	response	`unknown`	No	Entity not found.
`409`	response	`unknown`	No	expected_revision does not match the stored revision.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`ETag`	200 header	`string`	No	Validator for the updated entity revision.

Response body

200application/jsonEntityResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`revision`	body	`integer`	Yes	None
`profile`	body	`EntityProfile-Output`	Yes	None
`profile.unit_name`	body	`string`	Yes	Human-readable unit or entity name.
`profile.sidc`	body	`string`	Yes	MIL-STD-2525 symbol identification code.
`profile.description`	body	`string \| null`	No	Free-text entity description.
`profile.affiliation`	body	`friendly \| hostile \| neutral \| unknown \| null`	No	Operational affiliation used by map styling and planning.
`profile.higher_hq`	body	`string \| null`	No	Name or identifier of the parent headquarters.
`profile.support_priority`	body	`integer \| null`	No	Relative support priority; lower positive numbers represent higher priority.
`profile.capabilities`	body	`array<PersonnelCapability \| EffectivenessPowerCapability \| GroundMobilityCapability-Output \| RadarCapability \| NonRadarSensorCapability \| ArtilleryCapability \| UASCapability \| CounterUASCapability \| OrbitalLaunchCapability \| GeneratorCapability \| RadioCapability-Output \| SuppliesCapability-Output \| MedicalRosterCapability-Output>`	No	Typed optional behaviors and domain data attached to this entity. Capability IDs must be stable and unique. Unknown models are accepted, but capability types and fields must match the documented schema.
`current_state`	body	`EntityCurrentState-Output \| null`	No	None
`current_state.observed_at`	body	`string \| null`	No	Time this state was observed; defaults to server receipt time when omitted.
`current_state.location`	body	`GeoJSONPoint \| GeoJSONPointFeature \| null`	No	Canonical GeoJSON location using [longitude, latitude] coordinate order.
`current_state.location.type`	body	`string`	No	None
`current_state.location.coordinates`	body	`array<unknown>`	Yes	GeoJSON coordinate pair in [longitude, latitude] order.
`current_state.stats`	body	`OperationalStats`	No	None
`current_state.stats.readiness`	body	`number`	No	Readiness fraction from 0 to 1.
`current_state.stats.equipment_condition`	body	`number`	No	Equipment-condition fraction from 0 to 1.
`current_state.stats.ammunition`	body	`number`	No	Ammunition fraction from 0 to 1.
`current_state.stats.fatigue`	body	`number`	No	Fatigue fraction from 0 to 1.
`current_state.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	Typed changing state for capabilities referenced by capability_id.
`metadata`	body	`object`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None
`deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X PATCH "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "profile": {
    "unit_name": {},
    "sidc": {},
    "description": {},
    "affiliation": {},
    "higher_hq": {},
    "support_priority": {},
    "capabilities": {}
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {},
    "capability_states": {}
  },
  "metadata": {},
  "expected_revision": 0
}'

Python

import requests

response = requests.patch(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "profile": {
            "unit_name": {},
            "sidc": {},
            "description": {},
            "affiliation": {},
            "higher_hq": {},
            "support_priority": {},
            "capabilities": {}
        },
        "current_state": {
            "observed_at": {},
            "location": {},
            "stats": {},
            "capability_states": {}
        },
        "metadata": {},
        "expected_revision": 0
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "revision": 0,
  "profile": {
    "unit_name": "string",
    "sidc": "string",
    "description": "string",
    "affiliation": "friendly",
    "higher_hq": "string",
    "support_priority": 0,
    "capabilities": [
      {
        "config": {
          "total": 90
        },
        "id": "personnel-1",
        "model": "Assigned strength",
        "schema_version": 1,
        "type": "organization.personnel"
      },
      {
        "config": {
          "value": 33.45
        },
        "id": "power-1",
        "model": "Operational estimate",
        "schema_version": 1,
        "type": "effectiveness.power"
      },
      {
        "config": {
          "total_capacity_gallons": 1323,
          "vehicles": [
            {
              "cross_country_gallons_per_hour": 11,
              "cross_country_speed_kph": 24,
              "fuel_capacity_gallons": 63,
              "idle_gallons_per_hour": 1.2,
              "max_load_kg": 1800,
              "model": "CUSTOM-WHEELED",
              "movement_type": "Wheeled",
              "primary_road_gallons_per_hour": 6.5,
              "primary_road_speed_kph": 72,
              "quantity": 21,
              "secondary_road_gallons_per_hour": 8,
              "secondary_road_speed_kph": 48
            }
          ]
        },
        "id": "ground-mobility-1",
        "model": "CUSTOM-WHEELED-PLATOON",
        "schema_version": 1,
        "type": "mobility.ground"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 120,
          "range_km": 42
        },
        "id": "radar-1",
        "model": "CUSTOM-RADAR-X",
        "schema_version": 1,
        "type": "sensor.radar"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 70,
          "range_km": 18
        },
        "id": "sensor-1",
        "model": "CUSTOM-EOIR-X",
        "schema_version": 1,
        "type": "sensor.non_radar"
      },
      {
        "config": {
          "max_range_meters": 24000
        },
        "id": "artillery-1",
        "model": "CUSTOM-HOWITZER-X",
        "schema_version": 1,
        "type": "fires.artillery"
      },
      {
        "config": {
          "max_range_km": 180,
          "max_speed_kph": 130
        },
        "id": "uas-1",
        "model": "CUSTOM-UAS-X",
        "schema_version": 1,
        "type": "aviation.uas"
      },
      {
        "config": {
          "directional": false,
          "field_of_view_degrees": 360,
          "range_km": 12
        },
        "id": "counter-uas-1",
        "model": "CUSTOM-CUAS-X",
        "schema_version": 1,
        "type": "defense.counter_uas"
      },
      {
        "config": {
          "classification": "Small launch vehicle",
          "debris_dispersion_radius_ft": 10000,
          "inhabited_building_distance_ft": 5000,
          "public_traffic_route_distance_ft": 3000
        },
        "id": "orbital-launch-1",
        "model": "CUSTOM-LAUNCH-X",
        "schema_version": 1,
        "type": "launch.orbital"
      },
      {
        "config": {
          "fuel_consumption_gallons_per_hour": 2.5,
          "fuel_type": "JP-8"
        },
        "id": "generator-1",
        "model": "CUSTOM-GENERATOR-X",
        "schema_version": 1,
        "type": "power.generator"
      },
      {
        "config": {
          "antenna": {
            "default_height_ft": 10,
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "height_override_ft": 30,
            "mast_model": "CUSTOM-MAST-X",
            "mast_supported": true,
            "model": "CUSTOM-ANTENNA-X"
          },
          "frequency_bands": [
            {
              "maximum_mhz": 400,
              "minimum_mhz": 225
            }
          ],
          "network_name": "command",
          "operating_frequency_mhz": 300,
          "power_levels": [
            {
              "data_expected_range_km": 20,
              "expected_range_km": 35,
              "id": "high",
              "label": "High",
              "max_effective_range_km": {
                "maximum": 45,
                "minimum": 30
              },
              "planning_range_km": {
                "maximum": 35,
                "minimum": 25
              },
              "power_output_watts": 50
            }
          ],
          "requires_antenna": true,
          "selected_power_level_id": "high"
        },
        "id": "radio-1",
        "model": "CUSTOM-RADIO-X",
        "schema_version": 1,
        "type": "communications.radio"
      },
      {
        "config": {
          "items": [
            {
              "daily_allocation": 3,
              "id": "food-1",
              "initial_stock": 900,
              "measurement_unit": "Rations",
              "supply_type": "Food"
            },
            {
              "fuel_type": "JP-8",
              "id": "fuel-1",
              "initial_stock": 1200,
              "measurement_unit": "Gallons",
              "supply_type": "Fuel"
            },
            {
              "daily_allocation": 2,
              "id": "water-1",
              "initial_stock": 600,
              "measurement_unit": "Gallons",
              "supply_type": "Water"
            },
            {
              "id": "shelter-1",
              "initial_stock": 10,
              "measurement_unit": "Tents",
              "supply_type": "Shelter"
            }
          ]
        },
        "id": "supplies-1",
        "model": "Unit stocks",
        "schema_version": 1,
        "type": "sustainment.supplies"
      },
      {
        "config": {
          "patients": [
            {
              "id": "patient-1"
            }
          ]
        },
        "id": "medical-1",
        "model": "Patient roster",
        "schema_version": 1,
        "type": "medical.roster"
      }
    ]
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  },
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

DELETE/api/operations/{operation_id}/entities/{entity_id}Archive an operation entity

Soft-archives the entity and returns its final archived representation.

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`expected_revision`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`EntityResponse`	No	Successful Response
`403`	response	`unknown`	No	Access denied.
`404`	response	`unknown`	No	Entity not found.
`409`	response	`unknown`	No	expected_revision does not match the stored revision.
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response headers

Name	In	Type	Required	Description
`ETag`	200 header	`string`	No	Validator for the archived entity revision.

Response body

200application/jsonEntityResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`revision`	body	`integer`	Yes	None
`profile`	body	`EntityProfile-Output`	Yes	None
`profile.unit_name`	body	`string`	Yes	Human-readable unit or entity name.
`profile.sidc`	body	`string`	Yes	MIL-STD-2525 symbol identification code.
`profile.description`	body	`string \| null`	No	Free-text entity description.
`profile.affiliation`	body	`friendly \| hostile \| neutral \| unknown \| null`	No	Operational affiliation used by map styling and planning.
`profile.higher_hq`	body	`string \| null`	No	Name or identifier of the parent headquarters.
`profile.support_priority`	body	`integer \| null`	No	Relative support priority; lower positive numbers represent higher priority.
`profile.capabilities`	body	`array<PersonnelCapability \| EffectivenessPowerCapability \| GroundMobilityCapability-Output \| RadarCapability \| NonRadarSensorCapability \| ArtilleryCapability \| UASCapability \| CounterUASCapability \| OrbitalLaunchCapability \| GeneratorCapability \| RadioCapability-Output \| SuppliesCapability-Output \| MedicalRosterCapability-Output>`	No	Typed optional behaviors and domain data attached to this entity. Capability IDs must be stable and unique. Unknown models are accepted, but capability types and fields must match the documented schema.
`current_state`	body	`EntityCurrentState-Output \| null`	No	None
`current_state.observed_at`	body	`string \| null`	No	Time this state was observed; defaults to server receipt time when omitted.
`current_state.location`	body	`GeoJSONPoint \| GeoJSONPointFeature \| null`	No	Canonical GeoJSON location using [longitude, latitude] coordinate order.
`current_state.location.type`	body	`string`	No	None
`current_state.location.coordinates`	body	`array<unknown>`	Yes	GeoJSON coordinate pair in [longitude, latitude] order.
`current_state.stats`	body	`OperationalStats`	No	None
`current_state.stats.readiness`	body	`number`	No	Readiness fraction from 0 to 1.
`current_state.stats.equipment_condition`	body	`number`	No	Equipment-condition fraction from 0 to 1.
`current_state.stats.ammunition`	body	`number`	No	Ammunition fraction from 0 to 1.
`current_state.stats.fatigue`	body	`number`	No	Fatigue fraction from 0 to 1.
`current_state.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	Typed changing state for capabilities referenced by capability_id.
`metadata`	body	`object`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None
`deleted_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>?expected_revision=<expected_revision>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "revision": 0,
  "profile": {
    "unit_name": "string",
    "sidc": "string",
    "description": "string",
    "affiliation": "friendly",
    "higher_hq": "string",
    "support_priority": 0,
    "capabilities": [
      {
        "config": {
          "total": 90
        },
        "id": "personnel-1",
        "model": "Assigned strength",
        "schema_version": 1,
        "type": "organization.personnel"
      },
      {
        "config": {
          "value": 33.45
        },
        "id": "power-1",
        "model": "Operational estimate",
        "schema_version": 1,
        "type": "effectiveness.power"
      },
      {
        "config": {
          "total_capacity_gallons": 1323,
          "vehicles": [
            {
              "cross_country_gallons_per_hour": 11,
              "cross_country_speed_kph": 24,
              "fuel_capacity_gallons": 63,
              "idle_gallons_per_hour": 1.2,
              "max_load_kg": 1800,
              "model": "CUSTOM-WHEELED",
              "movement_type": "Wheeled",
              "primary_road_gallons_per_hour": 6.5,
              "primary_road_speed_kph": 72,
              "quantity": 21,
              "secondary_road_gallons_per_hour": 8,
              "secondary_road_speed_kph": 48
            }
          ]
        },
        "id": "ground-mobility-1",
        "model": "CUSTOM-WHEELED-PLATOON",
        "schema_version": 1,
        "type": "mobility.ground"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 120,
          "range_km": 42
        },
        "id": "radar-1",
        "model": "CUSTOM-RADAR-X",
        "schema_version": 1,
        "type": "sensor.radar"
      },
      {
        "config": {
          "directional": true,
          "field_of_view_degrees": 70,
          "range_km": 18
        },
        "id": "sensor-1",
        "model": "CUSTOM-EOIR-X",
        "schema_version": 1,
        "type": "sensor.non_radar"
      },
      {
        "config": {
          "max_range_meters": 24000
        },
        "id": "artillery-1",
        "model": "CUSTOM-HOWITZER-X",
        "schema_version": 1,
        "type": "fires.artillery"
      },
      {
        "config": {
          "max_range_km": 180,
          "max_speed_kph": 130
        },
        "id": "uas-1",
        "model": "CUSTOM-UAS-X",
        "schema_version": 1,
        "type": "aviation.uas"
      },
      {
        "config": {
          "directional": false,
          "field_of_view_degrees": 360,
          "range_km": 12
        },
        "id": "counter-uas-1",
        "model": "CUSTOM-CUAS-X",
        "schema_version": 1,
        "type": "defense.counter_uas"
      },
      {
        "config": {
          "classification": "Small launch vehicle",
          "debris_dispersion_radius_ft": 10000,
          "inhabited_building_distance_ft": 5000,
          "public_traffic_route_distance_ft": 3000
        },
        "id": "orbital-launch-1",
        "model": "CUSTOM-LAUNCH-X",
        "schema_version": 1,
        "type": "launch.orbital"
      },
      {
        "config": {
          "fuel_consumption_gallons_per_hour": 2.5,
          "fuel_type": "JP-8"
        },
        "id": "generator-1",
        "model": "CUSTOM-GENERATOR-X",
        "schema_version": 1,
        "type": "power.generator"
      },
      {
        "config": {
          "antenna": {
            "default_height_ft": 10,
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "height_override_ft": 30,
            "mast_model": "CUSTOM-MAST-X",
            "mast_supported": true,
            "model": "CUSTOM-ANTENNA-X"
          },
          "frequency_bands": [
            {
              "maximum_mhz": 400,
              "minimum_mhz": 225
            }
          ],
          "network_name": "command",
          "operating_frequency_mhz": 300,
          "power_levels": [
            {
              "data_expected_range_km": 20,
              "expected_range_km": 35,
              "id": "high",
              "label": "High",
              "max_effective_range_km": {
                "maximum": 45,
                "minimum": 30
              },
              "planning_range_km": {
                "maximum": 35,
                "minimum": 25
              },
              "power_output_watts": 50
            }
          ],
          "requires_antenna": true,
          "selected_power_level_id": "high"
        },
        "id": "radio-1",
        "model": "CUSTOM-RADIO-X",
        "schema_version": 1,
        "type": "communications.radio"
      },
      {
        "config": {
          "items": [
            {
              "daily_allocation": 3,
              "id": "food-1",
              "initial_stock": 900,
              "measurement_unit": "Rations",
              "supply_type": "Food"
            },
            {
              "fuel_type": "JP-8",
              "id": "fuel-1",
              "initial_stock": 1200,
              "measurement_unit": "Gallons",
              "supply_type": "Fuel"
            },
            {
              "daily_allocation": 2,
              "id": "water-1",
              "initial_stock": 600,
              "measurement_unit": "Gallons",
              "supply_type": "Water"
            },
            {
              "id": "shelter-1",
              "initial_stock": 10,
              "measurement_unit": "Tents",
              "supply_type": "Shelter"
            }
          ]
        },
        "id": "supplies-1",
        "model": "Unit stocks",
        "schema_version": 1,
        "type": "sustainment.supplies"
      },
      {
        "config": {
          "patients": [
            {
              "id": "patient-1"
            }
          ]
        },
        "id": "medical-1",
        "model": "Patient roster",
        "schema_version": 1,
        "type": "medical.roster"
      }
    ]
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  },
  "metadata": {},
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

Entity Resolution4 operations

GET/api/entity-resolution/entities/{entity_id}/historyEntityresolutionrouter.List Entity History

Parameters

Name	In	Type	Required	Description
`entity_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entity-resolution/entities/<entity_id>/history" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entity-resolution/entities/<entity_id>/history",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/entity-resolution/entities/{entity_id}/observationsEntityresolutionrouter.List Entity Observations

Parameters

Name	In	Type	Required	Description
`entity_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entity-resolution/entities/<entity_id>/observations" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entity-resolution/entities/<entity_id>/observations",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

DELETE/api/entity-resolution/entities/clearEntityresolutionrouter.Clear Entity Resolution

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/entity-resolution/entities/clear" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/entity-resolution/entities/clear",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/entity-resolution/entities/currentEntityresolutionrouter.List Current Entities

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entity-resolution/entities/current" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entity-resolution/entities/current",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

entropy5 operations

GET/api/entropy/v1/flight-operationsList Flight Operations

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entropy/v1/flight-operations" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entropy/v1/flight-operations",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/entropy/v1/flight-operations/{flight_op_id}/vehiclesList Vehicles

Parameters

Name	In	Type	Required	Description
`flight_op_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

PUT/api/entropy/v1/flight-operations/{flight_op_id}/vehicles/{vehicle_id}/missions/{mission_id}Upload Mission

Parameters

Name	In	Type	Required	Description
`flight_op_id`	path	`string`	Yes	None
`vehicle_id`	path	`string`	Yes	None
`mission_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/missions/<mission_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/missions/<mission_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/entropy/v1/flight-operations/{flight_op_id}/vehicles/{vehicle_id}/missions/{mission_id}/executionStart Mission Execution

Parameters

Name	In	Type	Required	Description
`flight_op_id`	path	`string`	Yes	None
`vehicle_id`	path	`string`	Yes	None
`mission_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/missions/<mission_id>/execution" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/missions/<mission_id>/execution",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/entropy/v1/flight-operations/{flight_op_id}/vehicles/{vehicle_id}/statusGet Vehicle Status

Parameters

Name	In	Type	Required	Description
`flight_op_id`	path	`string`	Yes	None
`vehicle_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/status" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/entropy/v1/flight-operations/<flight_op_id>/vehicles/<vehicle_id>/status",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

Groups7 operations

POST/api/groups/Grouprouter.Create Group

Parameters

Name	In	Type	Required	Description
`name`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`GroupResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonGroupResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`number_members`	body	`integer`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/groups/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/groups/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "number_members": 0,
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

GET/api/groups/Grouprouter.Get Groups

Parameters

Name	In	Type	Required	Description
`not_in_operation_id`	query	`string \| null`	No	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None
`query`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListGroupResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListGroupResponse

Name	In	Type	Required	Description
`groups`	body	`array<GroupResponse>`	Yes	None
`groups[].id`	body	`string`	Yes	None
`groups[].name`	body	`string`	Yes	None
`groups[].number_members`	body	`integer`	Yes	None
`groups[].created_at`	body	`string \| null`	No	None
`groups[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/groups/?not_in_operation_id=<not_in_operation_id>&size=<size>&page=<page>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/groups/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "groups": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "number_members": 0,
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/groups/{group_id}Grouprouter.Update Group

Parameters

Name	In	Type	Required	Description
`group_id`	path	`string`	Yes	None
`name`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/groups/<group_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/groups/<group_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/groups/{group_id}/membersGroupmemberrouter.Get Group Members By Group

Parameters

Name	In	Type	Required	Description
`group_id`	path	`string`	Yes	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListMemberInGroupResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListMemberInGroupResponse

Name	In	Type	Required	Description
`members`	body	`array<MemberInGroupResponse>`	Yes	None
`members[].group_member_id`	body	`string`	Yes	None
`members[].member_id`	body	`string`	Yes	None
`members[].name`	body	`string`	Yes	None
`members[].role`	body	`UserRole`	Yes	None
`members[].picture_url`	body	`string \| null`	No	None
`members[].email`	body	`string`	Yes	None
`members[].created_at`	body	`string \| null`	No	None
`members[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/groups/<group_id>/members?size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/groups/<group_id>/members",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "members": [
    {
      "group_member_id": "00000000-0000-0000-0000-000000000000",
      "member_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "role": "Admin",
      "picture_url": {},
      "email": "string",
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/groups/membersGroupmemberrouter.Create Group Member

Parameters

Name	In	Type	Required	Description
`group_id`	body	`string`	Yes	None
`member_id`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/groups/members" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "group_id": "00000000-0000-0000-0000-000000000000",
  "member_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/groups/members",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "group_id": "00000000-0000-0000-0000-000000000000",
        "member_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/groups/membersGroupmemberrouter.Get Group Members

Parameters

Name	In	Type	Required	Description
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None
`query`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListGroupMemberResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListGroupMemberResponse

Name	In	Type	Required	Description
`group_members`	body	`array<GroupMemberResponse>`	Yes	None
`group_members[].member_id`	body	`string`	Yes	None
`group_members[].name`	body	`string`	Yes	None
`group_members[].email`	body	`string`	Yes	None
`group_members[].role`	body	`UserRole`	Yes	None
`group_members[].picture_url`	body	`string \| null`	No	None
`group_members[].groups`	body	`array<Group>`	Yes	None
`group_members[].created_at`	body	`string \| null`	No	None
`group_members[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/groups/members?size=<size>&page=<page>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/groups/members",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "group_members": [
    {
      "member_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "email": "string",
      "role": "Admin",
      "picture_url": {},
      "groups": [
        {}
      ],
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

DELETE/api/groups/members/{group_member_id}Groupmemberrouter.Delete Group Member

Parameters

Name	In	Type	Required	Description
`group_member_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/groups/members/<group_member_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/groups/members/<group_member_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

Health1 operations

GET/api/health/Healthrouter.Health

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/health/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/health/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

Jobs3 operations

POST/api/jobs/Jobsrouter.Create Job

Parameters

Name	In	Type	Required	Description
`job_type`	body	`integer`	Yes	None
`name`	body	`string`	Yes	None
`input_data`	body	`object`	Yes	None
`retries`	body	`integer \| null`	No	None
`timeout_seconds`	body	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`JobResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonJobResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string \| null`	Yes	None
`parent_job_id`	body	`string \| null`	No	None
`name`	body	`string`	Yes	None
`job_type`	body	`integer`	Yes	None
`input_data`	body	`object \| null`	Yes	None
`status`	body	`JobStatus`	Yes	None
`result`	body	`JobResult`	Yes	None
`result_context`	body	`object \| null`	Yes	None
`progress_context`	body	`object \| null`	No	None
`retries_remaining`	body	`integer`	Yes	None
`worker_id`	body	`string \| null`	Yes	None
`started_at`	body	`string \| null`	Yes	None
`cancel_requested_at`	body	`string \| null`	No	None
`available_at`	body	`string`	Yes	None
`timeout_seconds`	body	`integer`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/jobs/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "job_type": 0,
  "name": "string",
  "input_data": {},
  "retries": 0,
  "timeout_seconds": 0
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/jobs/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "job_type": 0,
        "name": "string",
        "input_data": {},
        "retries": 0,
        "timeout_seconds": 0
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "parent_job_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "job_type": 0
}

GET/api/jobs/Jobsrouter.Get Jobs

Parameters

Name	In	Type	Required	Description
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None
`job_id`	query	`string \| null`	No	None
`name`	query	`string \| null`	No	None
`job_type`	query	`integer`	Yes	None
`status`	query	`JobStatus \| null`	No	None
`result`	query	`JobResult \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListJobsResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListJobsResponse

Name	In	Type	Required	Description
`jobs`	body	`array<JobResponse>`	Yes	None
`jobs[].id`	body	`string`	Yes	None
`jobs[].created_at`	body	`string`	Yes	None
`jobs[].updated_at`	body	`string \| null`	Yes	None
`jobs[].deleted_at`	body	`string \| null`	Yes	None
`jobs[].user_id`	body	`string \| null`	Yes	None
`jobs[].parent_job_id`	body	`string \| null`	No	None
`jobs[].name`	body	`string`	Yes	None
`jobs[].job_type`	body	`integer`	Yes	None
`jobs[].input_data`	body	`object \| null`	Yes	None
`jobs[].status`	body	`JobStatus`	Yes	None
`jobs[].result`	body	`JobResult`	Yes	None
`jobs[].result_context`	body	`object \| null`	Yes	None
`jobs[].progress_context`	body	`object \| null`	No	None
`jobs[].retries_remaining`	body	`integer`	Yes	None
`jobs[].worker_id`	body	`string \| null`	Yes	None
`jobs[].started_at`	body	`string \| null`	Yes	None
`jobs[].cancel_requested_at`	body	`string \| null`	No	None
`jobs[].available_at`	body	`string`	Yes	None
`jobs[].timeout_seconds`	body	`integer`	Yes	None
`pagination`	body	`PaginationResponse \| null`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/jobs/?size=<size>&page=<page>&job_id=<job_id>&name=<name>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/jobs/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "jobs": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-01T00:00:00Z",
      "updated_at": {},
      "deleted_at": {},
      "user_id": {},
      "parent_job_id": {},
      "name": "string",
      "job_type": 0
    }
  ],
  "pagination": {
    "current_page": {},
    "total_pages": {},
    "total_records": {}
  }
}

POST/api/jobs/cancel/{job_id}Jobsrouter.Cancel Job

Parameters

Name	In	Type	Required	Description
`job_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`JobResponse \| null`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonJobResponse | null

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string \| null`	Yes	None
`parent_job_id`	body	`string \| null`	No	None
`name`	body	`string`	Yes	None
`job_type`	body	`integer`	Yes	None
`input_data`	body	`object \| null`	Yes	None
`status`	body	`JobStatus`	Yes	None
`result`	body	`JobResult`	Yes	None
`result_context`	body	`object \| null`	Yes	None
`progress_context`	body	`object \| null`	No	None
`retries_remaining`	body	`integer`	Yes	None
`worker_id`	body	`string \| null`	Yes	None
`started_at`	body	`string \| null`	Yes	None
`cancel_requested_at`	body	`string \| null`	No	None
`available_at`	body	`string`	Yes	None
`timeout_seconds`	body	`integer`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/jobs/cancel/<job_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/jobs/cancel/<job_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "parent_job_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "job_type": 0
}

Landing Zones1 operations

POST/api/landing-zones/Landingzonerouter.Survey Landing Zones

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`boundary_shape`	body	`object`	Yes	None
`platform`	body	`AircraftPlatform`	Yes	None
`mobility_config`	body	`PathfindingMobilityConfig \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`BaseMapLayerSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonBaseMapLayerSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`layer_type`	body	`MapLayerType`	Yes	None
`availability`	body	`string`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/landing-zones/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "boundary_shape": {},
  "platform": "c17",
  "mobility_config": {
    "use_slope": true,
    "slope_restricted_deg": 4,
    "slope_severe_deg": 6,
    "use_tri": true,
    "tri_restricted_m": 12,
    "tri_severe_m": 24,
    "use_landcover": true,
    "landcover_classes": {}
  }
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/landing-zones/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "boundary_shape": {},
        "platform": "c17",
        "mobility_config": {
            "use_slope": true,
            "slope_restricted_deg": 4,
            "slope_severe_deg": 6,
            "use_tri": true,
            "tri_restricted_m": 12,
            "tri_severe_m": 24,
            "use_landcover": true,
            "landcover_classes": {}
        }
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {}
}

Maps4 operations

POST/api/maps/Maprouter.Create Map

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`name`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MapSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMapSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/maps/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "name": "untitled"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/maps/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "name": "untitled"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "name": "string"
}

GET/api/maps/Maprouter.Get Maps

Parameters

Name	In	Type	Required	Description
`operation_id`	query	`string`	Yes	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListMapResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListMapResponse

Name	In	Type	Required	Description
`maps`	body	`array<MapSchema>`	Yes	None
`maps[].id`	body	`string`	Yes	None
`maps[].created_at`	body	`string`	Yes	None
`maps[].updated_at`	body	`string \| null`	Yes	None
`maps[].deleted_at`	body	`string \| null`	Yes	None
`maps[].user_id`	body	`string`	Yes	None
`maps[].operation_id`	body	`string`	Yes	None
`maps[].name`	body	`string`	Yes	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/?operation_id=<operation_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "maps": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-01T00:00:00Z",
      "updated_at": {},
      "deleted_at": {},
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/maps/{map_id}Maprouter.Update Map

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`name`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/maps/<map_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/maps/<map_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

DELETE/api/maps/{map_id}Maprouter.Delete Map

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/maps/<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/maps/<map_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

MSS4 operations

POST/api/mss/Mssrouter.Generate Mss

Parameters

Name	In	Type	Required	Description
`engine`	query	`object \| null`	No	None
`session_factory`	query	`object \| null`	No	None
`pool_size`	query	`integer \| null`	No	None
`max_overflow`	query	`integer \| null`	No	None
`inputs`	body	`object`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/mss/?engine=<engine>&session_factory=<session_factory>&pool_size=<pool_size>&max_overflow=<max_overflow>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {}
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/mss/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "inputs": {}
    },
)
print(response.json())

Example response

{}

GET/api/mss/Mssrouter.Get Mss

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string \| null`	Yes	None
`engine`	query	`object \| null`	No	None
`session_factory`	query	`object \| null`	No	None
`pool_size`	query	`integer \| null`	No	None
`max_overflow`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/mss/?map_id=<map_id>&engine=<engine>&session_factory=<session_factory>&pool_size=<pool_size>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/mss/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/mss/cancelMssrouter.Cancel Mss

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string`	Yes	None
`engine`	query	`object \| null`	No	None
`session_factory`	query	`object \| null`	No	None
`pool_size`	query	`integer \| null`	No	None
`max_overflow`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/mss/cancel?map_id=<map_id>&engine=<engine>&session_factory=<session_factory>&pool_size=<pool_size>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/mss/cancel",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/mss/rankMssrouter.Mss Rank

Parameters

Name	In	Type	Required	Description
`engine`	query	`object \| null`	No	None
`session_factory`	query	`object \| null`	No	None
`pool_size`	query	`integer \| null`	No	None
`max_overflow`	query	`integer \| null`	No	None
`map_id`	body	`string`	Yes	None
`weights`	body	`object`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/mss/rank?engine=<engine>&session_factory=<session_factory>&pool_size=<pool_size>&max_overflow=<max_overflow>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "weights": {}
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/mss/rank",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "weights": {}
    },
)
print(response.json())

Example response

{}

odin2 operations

GET/api/odin/unitsOdinrouter.Search Units

Search ODIN units by name and return the complete result set.

Parameters

Name	In	Type	Required	Description
`name`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/odin/units?name=<name>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/odin/units",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/odin/units/{unit_id}/hierarchyOdinrouter.Get Unit Hierarchy

Get the ODIN order of battle rooted at a unit.

Parameters

Name	In	Type	Required	Description
`unit_id`	path	`integer`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/odin/units/<unit_id>/hierarchy" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/odin/units/<unit_id>/hierarchy",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

OGC — Global Directory2 operations

GET/api/ogcGlobal Ogc Directory

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/Global Ogc Directory

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

OGC — Map Directory2 operations

GET/api/maps/{map_id}/ogcMap Ogc Directory

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/Map Ogc Directory

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

OGC — STAC12 operations

GET/api/ogc/stacLanding Page

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/Landing Page

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/apiService Description

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/api" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/api",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/catalogs/{source_id}Source Catalog

Parameters

Name	In	Type	Required	Description
`source_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/catalogs/<source_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/catalogs/<source_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/collectionsCollections

Parameters

Name	In	Type	Required	Description
`q`	query	`string \| null`	No	None
`source`	query	`string \| null`	No	None
`access_scope`	query	`string \| null`	No	None
`has_display`	query	`boolean \| null`	No	None
`limit`	query	`integer`	No	None
`token`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/collections?q=<q>&source=<source>&access_scope=<access_scope>&has_display=<has_display>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/collections",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/collections/{collection_id}Collection

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/collections/{collection_id}/itemsCollection Items

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None
`limit`	query	`integer`	No	None
`token`	query	`string \| null`	No	None
`bbox`	query	`string \| null`	No	None
`datetime`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/geo+json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/geo+jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>/items?limit=<limit>&token=<token>&bbox=<bbox>&datetime=<datetime>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>/items",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/collections/{collection_id}/items/{item_id}Item

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None
`item_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/geo+json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/geo+jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>/items/<item_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/collections/<collection_id>/items/<item_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/conformanceConformance

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None
`{key}`	body	`array<string>`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/conformance" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/conformance",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/extensions/blue/v1.0.0/schema.jsonBlue Extension Schema

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/extensions/blue/v1.0.0/schema.json" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/extensions/blue/v1.0.0/schema.json",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/stac/searchSearch Get

Parameters

Name	In	Type	Required	Description
`collections`	query	`string \| null`	No	None
`ids`	query	`string \| null`	No	None
`bbox`	query	`string \| null`	No	None
`datetime`	query	`string \| null`	No	None
`limit`	query	`integer`	No	None
`token`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/geo+json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/geo+jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/stac/search?collections=<collections>&ids=<ids>&bbox=<bbox>&datetime=<datetime>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/stac/search",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/ogc/stac/searchSearch Post

Parameters

Name	In	Type	Required	Description
`body`	application/json	`object`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/geo+json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/geo+jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/ogc/stac/search" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/ogc/stac/search",
    headers={"Authorization": "Bearer <api-key>"},
    json={},
)
print(response.json())

Example response

{}

OGC API — Global Tiles9 operations

GET/api/ogc/tilesGlobal Landing Page Without Redirect

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/Globalogctilesrouter.Landing Page

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/apiGlobalogctilesrouter.Api Definition

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/api" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/api",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/collectionsGlobalogctilesrouter.Collections

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/collections" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/collections",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/collections/{collection_id}Globalogctilesrouter.Collection

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/collections/{collection_id}/tilesGlobalogctilesrouter.Tilesets

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TileSetsList`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTileSetsList

Name	In	Type	Required	Description
`tilesets`	body	`array<TileSetMetadata>`	Yes	None
`tilesets[].title`	body	`string`	Yes	None
`tilesets[].description`	body	`string`	Yes	None
`tilesets[].dataType`	body	`map \| vector \| coverage`	Yes	None
`tilesets[].crs`	body	`string`	Yes	None
`tilesets[].mediaTypes`	body	`array<string>`	Yes	None
`tilesets[].tileMatrixSetURI`	body	`string`	Yes	None
`tilesets[].tileMatrixSetLimits`	body	`array<TileMatrixLimit>`	Yes	None
`tilesets[].links`	body	`array<OgcLink>`	Yes	None
`tilesets[].blue:source_layer`	body	`string \| null`	No	None
`tilesets[].blue:encoding`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "tilesets": [
    {
      "title": "string",
      "description": "string",
      "dataType": "map",
      "crs": "string",
      "mediaTypes": [
        {}
      ],
      "tileMatrixSetURI": "string",
      "tileMatrixSetLimits": [
        {}
      ],
      "links": [
        {}
      ]
    }
  ]
}

GET/api/ogc/tiles/collections/{collection_id}/tiles/{tile_matrix_set_id}Globalogctilesrouter.Tileset

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None
`tile_matrix_set_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TileSetMetadata`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTileSetMetadata

Name	In	Type	Required	Description
`title`	body	`string`	Yes	None
`description`	body	`string`	Yes	None
`dataType`	body	`map \| vector \| coverage`	Yes	None
`crs`	body	`string`	Yes	None
`mediaTypes`	body	`array<string>`	Yes	None
`tileMatrixSetURI`	body	`string`	Yes	None
`tileMatrixSetLimits`	body	`array<TileMatrixLimit>`	Yes	None
`tileMatrixSetLimits[].tileMatrix`	body	`string`	Yes	None
`tileMatrixSetLimits[].minTileRow`	body	`integer`	Yes	None
`tileMatrixSetLimits[].maxTileRow`	body	`integer`	Yes	None
`tileMatrixSetLimits[].minTileCol`	body	`integer`	Yes	None
`tileMatrixSetLimits[].maxTileCol`	body	`integer`	Yes	None
`links`	body	`array<OgcLink>`	Yes	None
`links[].href`	body	`string`	Yes	None
`links[].rel`	body	`string`	Yes	None
`links[].type`	body	`string \| null`	No	None
`links[].title`	body	`string \| null`	No	None
`links[].templated`	body	`boolean \| null`	No	None
`blue:source_layer`	body	`string \| null`	No	None
`blue:encoding`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "title": "string",
  "description": "string",
  "dataType": "map",
  "crs": "string",
  "mediaTypes": [
    "string"
  ],
  "tileMatrixSetURI": "string",
  "tileMatrixSetLimits": [
    {
      "tileMatrix": "string",
      "minTileRow": 0,
      "maxTileRow": 0,
      "minTileCol": 0,
      "maxTileCol": 0
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "type": {},
      "title": {},
      "templated": {}
    }
  ]
}

GET/api/ogc/tiles/collections/{collection_id}/tiles/{tile_matrix_set_id}/{tile_matrix}/{tile_row}/{tile_col}.{tile_format}Globalogctilesrouter.Tile

Parameters

Name	In	Type	Required	Description
`collection_id`	path	`string`	Yes	None
`tile_matrix_set_id`	path	`string`	Yes	None
`tile_matrix`	path	`string`	Yes	None
`tile_row`	path	`string`	Yes	None
`tile_col`	path	`string`	Yes	None
`tile_format`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>/<tile_matrix>/<tile_row>/<tile_col>.<tile_format>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>/<tile_matrix>/<tile_row>/<tile_col>.<tile_format>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/ogc/tiles/conformanceGlobalogctilesrouter.Conformance

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`ConformanceDeclaration`	No	Successful Response

Response body

200application/jsonConformanceDeclaration

Name	In	Type	Required	Description
`conformsTo`	body	`array<string>`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/ogc/tiles/conformance" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/ogc/tiles/conformance",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "conformsTo": [
    "string"
  ]
}

OGC API — Map Features8 operations

GET/api/maps/{map_id}/ogc/featuresLanding Page Without Redirect

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/Ogcfeaturesrouter.Landing Page

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/apiOgcfeaturesrouter.Api Definition

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/api" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/api",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/collectionsOgcfeaturesrouter.Collections

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/collections/{collection_id}Ogcfeaturesrouter.Collection

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/collections/{collection_id}/itemsOgcfeaturesrouter.Items

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None
`bbox`	query	`string \| null`	No	None
`datetime`	query	`string \| null`	No	None
`limit`	query	`string \| null`	No	None
`offset`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>/items?bbox=<bbox>&datetime=<datetime>&limit=<limit>&offset=<offset>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>/items",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/collections/{collection_id}/items/{feature_id}Ogcfeaturesrouter.Item

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None
`feature_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>/items/<feature_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/collections/<collection_id>/items/<feature_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/features/conformanceOgcfeaturesrouter.Conformance

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/conformance" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/features/conformance",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

OGC API — Map Tiles9 operations

GET/api/maps/{map_id}/ogc/tilesMap Landing Page Without Redirect

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/Mapogctilesrouter.Landing Page

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/apiMapogctilesrouter.Api Definition

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/api" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/api",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/collectionsMapogctilesrouter.Collections

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/collections/{collection_id}Mapogctilesrouter.Collection

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/collections/{collection_id}/tilesMapogctilesrouter.Tilesets

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TileSetsList`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTileSetsList

Name	In	Type	Required	Description
`tilesets`	body	`array<TileSetMetadata>`	Yes	None
`tilesets[].title`	body	`string`	Yes	None
`tilesets[].description`	body	`string`	Yes	None
`tilesets[].dataType`	body	`map \| vector \| coverage`	Yes	None
`tilesets[].crs`	body	`string`	Yes	None
`tilesets[].mediaTypes`	body	`array<string>`	Yes	None
`tilesets[].tileMatrixSetURI`	body	`string`	Yes	None
`tilesets[].tileMatrixSetLimits`	body	`array<TileMatrixLimit>`	Yes	None
`tilesets[].links`	body	`array<OgcLink>`	Yes	None
`tilesets[].blue:source_layer`	body	`string \| null`	No	None
`tilesets[].blue:encoding`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "tilesets": [
    {
      "title": "string",
      "description": "string",
      "dataType": "map",
      "crs": "string",
      "mediaTypes": [
        {}
      ],
      "tileMatrixSetURI": "string",
      "tileMatrixSetLimits": [
        {}
      ],
      "links": [
        {}
      ]
    }
  ]
}

GET/api/maps/{map_id}/ogc/tiles/collections/{collection_id}/tiles/{tile_matrix_set_id}Mapogctilesrouter.Tileset

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None
`tile_matrix_set_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TileSetMetadata`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTileSetMetadata

Name	In	Type	Required	Description
`title`	body	`string`	Yes	None
`description`	body	`string`	Yes	None
`dataType`	body	`map \| vector \| coverage`	Yes	None
`crs`	body	`string`	Yes	None
`mediaTypes`	body	`array<string>`	Yes	None
`tileMatrixSetURI`	body	`string`	Yes	None
`tileMatrixSetLimits`	body	`array<TileMatrixLimit>`	Yes	None
`tileMatrixSetLimits[].tileMatrix`	body	`string`	Yes	None
`tileMatrixSetLimits[].minTileRow`	body	`integer`	Yes	None
`tileMatrixSetLimits[].maxTileRow`	body	`integer`	Yes	None
`tileMatrixSetLimits[].minTileCol`	body	`integer`	Yes	None
`tileMatrixSetLimits[].maxTileCol`	body	`integer`	Yes	None
`links`	body	`array<OgcLink>`	Yes	None
`links[].href`	body	`string`	Yes	None
`links[].rel`	body	`string`	Yes	None
`links[].type`	body	`string \| null`	No	None
`links[].title`	body	`string \| null`	No	None
`links[].templated`	body	`boolean \| null`	No	None
`blue:source_layer`	body	`string \| null`	No	None
`blue:encoding`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "title": "string",
  "description": "string",
  "dataType": "map",
  "crs": "string",
  "mediaTypes": [
    "string"
  ],
  "tileMatrixSetURI": "string",
  "tileMatrixSetLimits": [
    {
      "tileMatrix": "string",
      "minTileRow": 0,
      "maxTileRow": 0,
      "minTileCol": 0,
      "maxTileCol": 0
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "type": {},
      "title": {},
      "templated": {}
    }
  ]
}

GET/api/maps/{map_id}/ogc/tiles/collections/{collection_id}/tiles/{tile_matrix_set_id}/{tile_matrix}/{tile_row}/{tile_col}.{tile_format}Mapogctilesrouter.Tile

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None
`collection_id`	path	`string`	Yes	None
`tile_matrix_set_id`	path	`string`	Yes	None
`tile_matrix`	path	`string`	Yes	None
`tile_row`	path	`string`	Yes	None
`tile_col`	path	`string`	Yes	None
`tile_format`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>/<tile_matrix>/<tile_row>/<tile_col>.<tile_format>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/collections/<collection_id>/tiles/<tile_matrix_set_id>/<tile_matrix>/<tile_row>/<tile_col>.<tile_format>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/maps/{map_id}/ogc/tiles/conformanceMapogctilesrouter.Conformance

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ConformanceDeclaration`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonConformanceDeclaration

Name	In	Type	Required	Description
`conformsTo`	body	`array<string>`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/conformance" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/maps/<map_id>/ogc/tiles/conformance",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "conformsTo": [
    "string"
  ]
}

Operations10 operations

POST/api/operations/Operationrouter.Create Operation

Parameters

Name	In	Type	Required	Description
`unit_id`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	No	None
`name`	body	`string`	Yes	None
`unit`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`OperationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonOperationResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`unit_id`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	Yes	None
`name`	body	`string`	Yes	None
`unit`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`policies`	body	`array<string>`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/operations/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "unit_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "unit": "string",
  "branch": "string",
  "echelon": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/operations/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "unit_id": "00000000-0000-0000-0000-000000000000",
        "parent_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "unit": "string",
        "branch": "string",
        "echelon": "string"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "unit_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "unit": "string",
  "branch": "string",
  "echelon": "string"
}

GET/api/operations/Operationrouter.Get Operations

Parameters

Name	In	Type	Required	Description
`unit_id`	query	`string \| null`	No	None
`parent_id`	query	`string \| null`	No	None
`force_all`	query	`boolean`	No	None
`query`	query	`string \| null`	No	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListOperationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListOperationResponse

Name	In	Type	Required	Description
`operations`	body	`array<OperationResponse>`	Yes	None
`operations[].id`	body	`string`	Yes	None
`operations[].user_id`	body	`string`	Yes	None
`operations[].unit_id`	body	`string \| null`	No	None
`operations[].parent_id`	body	`string \| null`	Yes	None
`operations[].name`	body	`string`	Yes	None
`operations[].unit`	body	`string`	Yes	None
`operations[].branch`	body	`string`	Yes	None
`operations[].echelon`	body	`string`	Yes	None
`operations[].policies`	body	`array<string>`	Yes	None
`operations[].created_at`	body	`string \| null`	No	None
`operations[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/?unit_id=<unit_id>&parent_id=<parent_id>&force_all=<force_all>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "operations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "unit_id": {},
      "parent_id": {},
      "name": "string",
      "unit": "string",
      "branch": "string",
      "echelon": "string"
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/operations/{operation_id}Operationrouter.Update Operation

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`unit_id`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	No	None
`name`	body	`string \| null`	No	None
`unit`	body	`string \| null`	No	None
`branch`	body	`string \| null`	No	None
`echelon`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/operations/<operation_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "unit_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "unit": "string",
  "branch": "string",
  "echelon": "string"
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/operations/<operation_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "unit_id": "00000000-0000-0000-0000-000000000000",
        "parent_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "unit": "string",
        "branch": "string",
        "echelon": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/operations/{operation_id}Operationrouter.Get Operation

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`OperationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonOperationResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`unit_id`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	Yes	None
`name`	body	`string`	Yes	None
`unit`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`policies`	body	`array<string>`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/<operation_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/<operation_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "unit_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "unit": "string",
  "branch": "string",
  "echelon": "string"
}

DELETE/api/operations/{operation_id}Operationrouter.Delete Operation

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`OperationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonOperationResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`unit_id`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	Yes	None
`name`	body	`string`	Yes	None
`unit`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`policies`	body	`array<string>`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/operations/<operation_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/operations/<operation_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "unit_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "unit": "string",
  "branch": "string",
  "echelon": "string"
}

GET/api/operations/{operation_id}/generated-maps/{asset_path}Operationrouter.Get Generated Map

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`asset_path`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/<operation_id>/generated-maps/<asset_path>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/generated-maps/<asset_path>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/operations/{operation_id}/membersOperationmemberrouter.Create Operation Member

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`members`	body	`array<OperationMember>`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/operations/<operation_id>/members" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "members": [
    {
      "member_id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/members",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "members": [
            {
                "member_id": "00000000-0000-0000-0000-000000000000",
                "type": "user"
            }
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/operations/{operation_id}/membersOperationmemberrouter.Get Operation Members

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None
`query`	query	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListOperationMemberResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListOperationMemberResponse

Name	In	Type	Required	Description
`operation_members`	body	`array<OperationMemberResponse>`	Yes	None
`operation_members[].id`	body	`string`	Yes	None
`operation_members[].member_id`	body	`string`	Yes	None
`operation_members[].name`	body	`string`	Yes	None
`operation_members[].email`	body	`string \| null`	No	None
`operation_members[].picture_url`	body	`string \| null`	No	None
`operation_members[].generation`	body	`boolean`	Yes	None
`operation_members[].type`	body	`OperationMemberType`	Yes	None
`operation_members[].roles`	body	`UserRole \| null`	No	None
`operation_members[].created_at`	body	`string \| null`	No	None
`operation_members[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/operations/<operation_id>/members?size=<size>&page=<page>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/members",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "operation_members": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "member_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "email": {},
      "picture_url": {},
      "generation": true,
      "type": "user",
      "roles": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/operations/{operation_id}/members/{operation_member_id}Operationmemberrouter.Update Operation Member

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`operation_member_id`	path	`string`	Yes	None
`generation`	body	`boolean \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/operations/<operation_id>/members/<operation_member_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "generation": true
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/members/<operation_member_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "generation": true
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

DELETE/api/operations/{operation_id}/members/{operation_member_id}Operationmemberrouter.Delete Operation Member

Parameters

Name	In	Type	Required	Description
`operation_id`	path	`string`	Yes	None
`operation_member_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/operations/<operation_id>/members/<operation_member_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/operations/<operation_id>/members/<operation_member_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

Pathfinding1 operations

POST/api/pathfinding/Pathfindingrouter.Find Path

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`formation`	body	`string`	Yes	None
`boundary_shape`	body	`object`	Yes	None
`path_start`	body	`array<unknown>`	Yes	None
`path_end`	body	`array<unknown>`	Yes	None
`cell_size_meters`	body	`integer \| null`	No	None
`corridor_width_km`	body	`number \| null`	No	None
`mobility_config`	body	`PathfindingMobilityConfig \| null`	No	None
`pathfinding_weights`	body	`PathfindingWeights \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`PathfindingResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonPathfindingResponse

Name	In	Type	Required	Description
`paths`	body	`array<PathResponseObject>`	No	None
`paths[].path`	body	`string`	Yes	None
`paths[].canalizing_polygons`	body	`string`	Yes	None
`paths[].overwatch_points`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/pathfinding/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "string",
  "echelon": "string",
  "formation": "string",
  "boundary_shape": {},
  "path_start": [
    {}
  ],
  "path_end": [
    {}
  ],
  "cell_size_meters": 0,
  "corridor_width_km": 0
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/pathfinding/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "string",
        "echelon": "string",
        "formation": "string",
        "boundary_shape": {},
        "path_start": [
            {}
        ],
        "path_end": [
            {}
        ],
        "cell_size_meters": 0,
        "corridor_width_km": 0
    },
)
print(response.json())

Example response

{
  "paths": [
    {
      "path": "string",
      "canalizing_polygons": "string",
      "overwatch_points": "string"
    }
  ]
}

SAPIENT8 operations

POST/api/sapient/v1/eventsReceive a SAPIENT gateway event

Gateway webhook for node lifecycle and BSI Flex 335 v2 messages. Requires a bearer API key with the SAPIENT scope.

Parameters

Name	In	Type	Required	Description
`schemaVersion`	body	`string`	Yes	None
`eventId`	body	`string`	Yes	None
`protocolVersion`	body	`string`	Yes	None
`eventType`	body	`string`	Yes	None
`occurredAt`	body	`string`	Yes	None
`connectionId`	body	`string`	Yes	None
`peerAddr`	body	`string`	Yes	None
`nodeId`	body	`string \| null`	No	None
`messageType`	body	`string \| null`	No	None
`message`	body	`object \| null`	No	None

Responses

Name	In	Type	Required	Description
`204`	response	`unknown`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/sapient/v1/events" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "schemaVersion": "string",
  "eventId": "string",
  "protocolVersion": "string",
  "eventType": "string",
  "occurredAt": "2026-06-01T00:00:00Z",
  "connectionId": "string",
  "peerAddr": "string",
  "nodeId": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/sapient/v1/events",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "schemaVersion": "string",
        "eventId": "string",
        "protocolVersion": "string",
        "eventType": "string",
        "occurredAt": "2026-06-01T00:00:00Z",
        "connectionId": "string",
        "peerAddr": "string",
        "nodeId": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{}

GET/api/sapient/v1/nodesList registered SAPIENT nodes

Lists registered nodes with connectivity, capabilities, current scenario association, position, and latest task state.

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`NodesResponse`	No	Successful Response

Response body

200application/jsonNodesResponse

Name	In	Type	Required	Description
`nodes`	body	`array<NodeView>`	Yes	None
`nodes[].id`	body	`string`	Yes	None
`nodes[].nodeId`	body	`string`	Yes	None
`nodes[].displayName`	body	`string`	Yes	None
`nodes[].sidc`	body	`string`	Yes	None
`nodes[].connected`	body	`boolean`	Yes	None
`nodes[].scenarioId`	body	`string \| null`	Yes	None
`nodes[].position`	body	`Position \| null`	No	None
`nodes[].supportedCommands`	body	`array<string>`	Yes	None
`nodes[].registration`	body	`object \| null`	Yes	None
`nodes[].statusReport`	body	`object \| null`	Yes	None
`nodes[].latestError`	body	`object \| null`	Yes	None
`nodes[].lastSeenAt`	body	`string`	Yes	None
`nodes[].currentTask`	body	`TaskView \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/sapient/v1/nodes" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/sapient/v1/nodes",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "nodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "nodeId": "00000000-0000-0000-0000-000000000000",
      "displayName": "string",
      "sidc": "string",
      "connected": true,
      "scenarioId": {},
      "position": {},
      "supportedCommands": [
        {}
      ]
    }
  ]
}

PUT/api/sapient/v1/nodes/{node_id}/scenarioAdd a SAPIENT node to a scenario

Associates a registered node with one Blue scenario so its live state and detections can be rendered there.

Parameters

Name	In	Type	Required	Description
`node_id`	path	`string`	Yes	None
`scenarioId`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`NodeView`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonNodeView

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`nodeId`	body	`string`	Yes	None
`displayName`	body	`string`	Yes	None
`sidc`	body	`string`	Yes	None
`connected`	body	`boolean`	Yes	None
`scenarioId`	body	`string \| null`	Yes	None
`position`	body	`Position \| null`	No	None
`position.latitude`	body	`number`	Yes	None
`position.longitude`	body	`number`	Yes	None
`position.altitudeM`	body	`number \| null`	No	None
`supportedCommands`	body	`array<string>`	Yes	None
`registration`	body	`object \| null`	Yes	None
`statusReport`	body	`object \| null`	Yes	None
`latestError`	body	`object \| null`	Yes	None
`lastSeenAt`	body	`string`	Yes	None
`currentTask`	body	`TaskView \| null`	No	None
`currentTask.taskId`	body	`string`	Yes	None
`currentTask.scenarioId`	body	`string \| null`	Yes	None
`currentTask.nodeId`	body	`string`	Yes	None
`currentTask.taskType`	body	`string`	Yes	None
`currentTask.sapientCommand`	body	`string`	Yes	None
`currentTask.status`	body	`SapientTaskStatus`	Yes	None
`currentTask.waypoints`	body	`array<object>`	Yes	None
`currentTask.reasons`	body	`array<string>`	Yes	None
`currentTask.submittedAt`	body	`string \| null`	Yes	None
`currentTask.acceptedAt`	body	`string \| null`	Yes	None
`currentTask.rejectedAt`	body	`string \| null`	Yes	None
`currentTask.completedAt`	body	`string \| null`	Yes	None
`currentTask.failedAt`	body	`string \| null`	Yes	None
`currentTask.stopRequestedAt`	body	`string \| null`	Yes	None
`currentTask.stoppedAt`	body	`string \| null`	Yes	None
`currentTask.createdAt`	body	`string`	Yes	None
`currentTask.updatedAt`	body	`string \| null`	Yes	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/sapient/v1/nodes/<node_id>/scenario" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "scenarioId": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/sapient/v1/nodes/<node_id>/scenario",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "scenarioId": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "nodeId": "00000000-0000-0000-0000-000000000000",
  "displayName": "string",
  "sidc": "string",
  "connected": true,
  "scenarioId": "00000000-0000-0000-0000-000000000000",
  "position": {
    "latitude": 0,
    "longitude": 0,
    "altitudeM": {}
  },
  "supportedCommands": [
    "string"
  ]
}

DELETE/api/sapient/v1/nodes/{node_id}/scenarioRemove a SAPIENT node from its scenario

Removes the scenario association without deleting the node, its detections, or its task history.

Parameters

Name	In	Type	Required	Description
`node_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`NodeView`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonNodeView

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`nodeId`	body	`string`	Yes	None
`displayName`	body	`string`	Yes	None
`sidc`	body	`string`	Yes	None
`connected`	body	`boolean`	Yes	None
`scenarioId`	body	`string \| null`	Yes	None
`position`	body	`Position \| null`	No	None
`position.latitude`	body	`number`	Yes	None
`position.longitude`	body	`number`	Yes	None
`position.altitudeM`	body	`number \| null`	No	None
`supportedCommands`	body	`array<string>`	Yes	None
`registration`	body	`object \| null`	Yes	None
`statusReport`	body	`object \| null`	Yes	None
`latestError`	body	`object \| null`	Yes	None
`lastSeenAt`	body	`string`	Yes	None
`currentTask`	body	`TaskView \| null`	No	None
`currentTask.taskId`	body	`string`	Yes	None
`currentTask.scenarioId`	body	`string \| null`	Yes	None
`currentTask.nodeId`	body	`string`	Yes	None
`currentTask.taskType`	body	`string`	Yes	None
`currentTask.sapientCommand`	body	`string`	Yes	None
`currentTask.status`	body	`SapientTaskStatus`	Yes	None
`currentTask.waypoints`	body	`array<object>`	Yes	None
`currentTask.reasons`	body	`array<string>`	Yes	None
`currentTask.submittedAt`	body	`string \| null`	Yes	None
`currentTask.acceptedAt`	body	`string \| null`	Yes	None
`currentTask.rejectedAt`	body	`string \| null`	Yes	None
`currentTask.completedAt`	body	`string \| null`	Yes	None
`currentTask.failedAt`	body	`string \| null`	Yes	None
`currentTask.stopRequestedAt`	body	`string \| null`	Yes	None
`currentTask.stoppedAt`	body	`string \| null`	Yes	None
`currentTask.createdAt`	body	`string`	Yes	None
`currentTask.updatedAt`	body	`string \| null`	Yes	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/sapient/v1/nodes/<node_id>/scenario" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/sapient/v1/nodes/<node_id>/scenario",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "nodeId": "00000000-0000-0000-0000-000000000000",
  "displayName": "string",
  "sidc": "string",
  "connected": true,
  "scenarioId": "00000000-0000-0000-0000-000000000000",
  "position": {
    "latitude": 0,
    "longitude": 0,
    "altitudeM": {}
  },
  "supportedCommands": [
    "string"
  ]
}

DELETE/api/sapient/v1/scenarios/{scenario_id}/detections/{detection_id}Delete Detection

Remove a detection that is currently visible in the requested scenario.

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`detection_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`204`	response	`unknown`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/sapient/v1/scenarios/<scenario_id>/detections/<detection_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/sapient/v1/scenarios/<scenario_id>/detections/<detection_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/sapient/v1/scenarios/{scenario_id}/stateGet live SAPIENT scenario state

Returns associated nodes, their latest task state, and detections reported by those nodes.

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioStateResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioStateResponse

Name	In	Type	Required	Description
`scenarioId`	body	`string`	Yes	None
`generatedAt`	body	`string`	Yes	None
`nodes`	body	`array<NodeView>`	Yes	None
`nodes[].id`	body	`string`	Yes	None
`nodes[].nodeId`	body	`string`	Yes	None
`nodes[].displayName`	body	`string`	Yes	None
`nodes[].sidc`	body	`string`	Yes	None
`nodes[].connected`	body	`boolean`	Yes	None
`nodes[].scenarioId`	body	`string \| null`	Yes	None
`nodes[].position`	body	`Position \| null`	No	None
`nodes[].supportedCommands`	body	`array<string>`	Yes	None
`nodes[].registration`	body	`object \| null`	Yes	None
`nodes[].statusReport`	body	`object \| null`	Yes	None
`nodes[].latestError`	body	`object \| null`	Yes	None
`nodes[].lastSeenAt`	body	`string`	Yes	None
`nodes[].currentTask`	body	`TaskView \| null`	No	None
`detections`	body	`array<DetectionView>`	Yes	None
`detections[].id`	body	`string`	Yes	None
`detections[].sourceNodeId`	body	`string`	Yes	None
`detections[].objectId`	body	`string`	Yes	None
`detections[].reportId`	body	`string \| null`	Yes	None
`detections[].displayName`	body	`string`	Yes	None
`detections[].sidc`	body	`string`	Yes	None
`detections[].position`	body	`Position \| null`	No	None
`detections[].classification`	body	`string \| null`	Yes	None
`detections[].confidence`	body	`number \| null`	Yes	None
`detections[].state`	body	`string \| null`	No	None
`detections[].taskId`	body	`string \| null`	No	None
`detections[].detectionReport`	body	`object \| null`	Yes	None
`detections[].lastSeenAt`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/sapient/v1/scenarios/<scenario_id>/state" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/sapient/v1/scenarios/<scenario_id>/state",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "scenarioId": "00000000-0000-0000-0000-000000000000",
  "generatedAt": "2026-06-01T00:00:00Z",
  "nodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "nodeId": "00000000-0000-0000-0000-000000000000",
      "displayName": "string",
      "sidc": "string",
      "connected": true,
      "scenarioId": {},
      "position": {},
      "supportedCommands": [
        {}
      ]
    }
  ],
  "detections": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "sourceNodeId": "00000000-0000-0000-0000-000000000000",
      "objectId": "string",
      "reportId": {},
      "displayName": "string",
      "sidc": "string",
      "position": {},
      "classification": {}
    }
  ]
}

POST/api/sapient/v1/tasksSubmit a reconnaissance task

Sends a tick-1 WGS84 reconnaissance route to an online node that advertises MOVE_TO support. Offline tasks fail immediately and are not queued.

Parameters

Name	In	Type	Required	Description
`scenarioId`	body	`string`	Yes	None
`nodeId`	body	`string`	Yes	None
`tick`	body	`integer`	Yes	None
`taskType`	body	`string`	Yes	None
`waypoints`	body	`array<Waypoint>`	Yes	None
`name`	body	`string \| null`	No	None
`description`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`202`	application/json	`TaskResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

202application/jsonTaskResponse

Name	In	Type	Required	Description
`task`	body	`TaskView`	Yes	None
`task.taskId`	body	`string`	Yes	None
`task.scenarioId`	body	`string \| null`	Yes	None
`task.nodeId`	body	`string`	Yes	None
`task.taskType`	body	`string`	Yes	None
`task.sapientCommand`	body	`string`	Yes	None
`task.status`	body	`SapientTaskStatus`	Yes	None
`task.waypoints`	body	`array<object>`	Yes	None
`task.reasons`	body	`array<string>`	Yes	None
`task.submittedAt`	body	`string \| null`	Yes	None
`task.acceptedAt`	body	`string \| null`	Yes	None
`task.rejectedAt`	body	`string \| null`	Yes	None
`task.completedAt`	body	`string \| null`	Yes	None
`task.failedAt`	body	`string \| null`	Yes	None
`task.stopRequestedAt`	body	`string \| null`	Yes	None
`task.stoppedAt`	body	`string \| null`	Yes	None
`task.createdAt`	body	`string`	Yes	None
`task.updatedAt`	body	`string \| null`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/sapient/v1/tasks" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "scenarioId": "00000000-0000-0000-0000-000000000000",
  "nodeId": "00000000-0000-0000-0000-000000000000",
  "tick": 0,
  "taskType": "string",
  "waypoints": [
    {
      "latitude": 0,
      "longitude": 0,
      "altitudeM": {}
    }
  ],
  "name": "string",
  "description": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/sapient/v1/tasks",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "scenarioId": "00000000-0000-0000-0000-000000000000",
        "nodeId": "00000000-0000-0000-0000-000000000000",
        "tick": 0,
        "taskType": "string",
        "waypoints": [
            {
                "latitude": 0,
                "longitude": 0,
                "altitudeM": {}
            }
        ],
        "name": "string",
        "description": "string"
    },
)
print(response.json())

Example response

{
  "task": {
    "taskId": "string",
    "scenarioId": "00000000-0000-0000-0000-000000000000",
    "nodeId": "00000000-0000-0000-0000-000000000000",
    "taskType": "string",
    "sapientCommand": "string",
    "status": "PENDING_SUBMISSION",
    "waypoints": [
      {}
    ],
    "reasons": [
      "string"
    ]
  }
}

POST/api/sapient/v1/tasks/{task_id}/stopStop an active SAPIENT task

Sends CONTROL_STOP for a submitted or accepted SAPIENT task and records the resulting lifecycle state.

Parameters

Name	In	Type	Required	Description
`task_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`202`	application/json	`TaskResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

202application/jsonTaskResponse

Name	In	Type	Required	Description
`task`	body	`TaskView`	Yes	None
`task.taskId`	body	`string`	Yes	None
`task.scenarioId`	body	`string \| null`	Yes	None
`task.nodeId`	body	`string`	Yes	None
`task.taskType`	body	`string`	Yes	None
`task.sapientCommand`	body	`string`	Yes	None
`task.status`	body	`SapientTaskStatus`	Yes	None
`task.waypoints`	body	`array<object>`	Yes	None
`task.reasons`	body	`array<string>`	Yes	None
`task.submittedAt`	body	`string \| null`	Yes	None
`task.acceptedAt`	body	`string \| null`	Yes	None
`task.rejectedAt`	body	`string \| null`	Yes	None
`task.completedAt`	body	`string \| null`	Yes	None
`task.failedAt`	body	`string \| null`	Yes	None
`task.stopRequestedAt`	body	`string \| null`	Yes	None
`task.stoppedAt`	body	`string \| null`	Yes	None
`task.createdAt`	body	`string`	Yes	None
`task.updatedAt`	body	`string \| null`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/sapient/v1/tasks/<task_id>/stop" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/sapient/v1/tasks/<task_id>/stop",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "task": {
    "taskId": "string",
    "scenarioId": "00000000-0000-0000-0000-000000000000",
    "nodeId": "00000000-0000-0000-0000-000000000000",
    "taskType": "string",
    "sapientCommand": "string",
    "status": "PENDING_SUBMISSION",
    "waypoints": [
      {}
    ],
    "reasons": [
      "string"
    ]
  }
}

Scenarios15 operations

POST/api/scenarios/Scenariorouter.Create

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`name`	body	`string \| null`	No	None
`json_data`	body	`object \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`schema_version`	body	`integer \| null`	No	None
`revision`	body	`integer`	No	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/scenarios/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "untitled",
  "json_data": {}
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/scenarios/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "name": "untitled",
        "json_data": {}
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {},
  "schema_version": 0
}

GET/api/scenarios/Scenariorouter.Get Scenarios

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string \| null`	No	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListScenarioResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListScenarioResponse

Name	In	Type	Required	Description
`scenarios`	body	`array<ScenarioSchema>`	Yes	None
`scenarios[].id`	body	`string`	Yes	None
`scenarios[].created_at`	body	`string`	Yes	None
`scenarios[].updated_at`	body	`string \| null`	Yes	None
`scenarios[].deleted_at`	body	`string \| null`	Yes	None
`scenarios[].map_id`	body	`string`	Yes	None
`scenarios[].name`	body	`string`	Yes	None
`scenarios[].json_data`	body	`object \| string \| null`	Yes	None
`scenarios[].schema_version`	body	`integer \| null`	No	None
`scenarios[].revision`	body	`integer`	No	None
`scenarios[].starts_at`	body	`string \| null`	No	None
`scenarios[].snapshot_duration_hours`	body	`number \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/scenarios/?map_id=<map_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/scenarios/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "scenarios": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-06-01T00:00:00Z",
      "updated_at": {},
      "deleted_at": {},
      "map_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "json_data": {},
      "schema_version": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/scenarios/{scenario_id}Scenariorouter.Get Scenario

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`schema_version`	body	`integer \| null`	No	None
`revision`	body	`integer`	No	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/scenarios/<scenario_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {},
  "schema_version": 0
}

PUT/api/scenarios/{scenario_id}Scenariorouter.Update Scenario

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`name`	body	`string \| null`	No	None
`json_data`	body	`object \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`schema_version`	body	`integer \| null`	No	None
`revision`	body	`integer`	No	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/scenarios/<scenario_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "json_data": {}
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string",
        "json_data": {}
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {},
  "schema_version": 0
}

DELETE/api/scenarios/{scenario_id}Scenariorouter.Delete Scenario

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioSchema`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioSchema

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	Yes	None
`deleted_at`	body	`string \| null`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`json_data`	body	`object \| string \| null`	Yes	None
`schema_version`	body	`integer \| null`	No	None
`revision`	body	`integer`	No	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/scenarios/<scenario_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z",
  "deleted_at": "2026-06-01T00:00:00Z",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "json_data": {},
  "schema_version": 0
}

POST/api/scenarios/{scenario_id}/entitiesScenariorouter.Add Scenario Entity

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`expected_scenario_revision`	body	`integer \| null`	No	None
`entity_id`	body	`string \| null`	No	None
`entity`	body	`EntityWriteRequest \| null`	No	None
`expected_entity_revision`	body	`integer \| null`	No	None
`current_state`	body	`EntityCurrentStatePatch \| null`	No	None
`introduced_at_tick`	body	`integer`	No	None
`associated_with_id`	body	`string \| null`	No	None
`planning_snapshot`	body	`ScenarioPlanningSnapshot-Input`	Yes	None
`initial_state_overrides`	body	`ScenarioInitialStateOverrides-Input`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioMembershipMutationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioMembershipMutationResponse

Name	In	Type	Required	Description
`scenario`	body	`ScenarioV2Response`	Yes	None
`scenario.id`	body	`string`	Yes	None
`scenario.map_id`	body	`string`	Yes	None
`scenario.name`	body	`string`	Yes	None
`scenario.schema_version`	body	`integer`	Yes	None
`scenario.revision`	body	`integer`	Yes	None
`scenario.starts_at`	body	`string`	Yes	None
`scenario.snapshot_duration_hours`	body	`number`	Yes	None
`scenario.plan`	body	`ScenarioPlanV2-Output`	Yes	None
`scenario.plan.schema_version`	body	`integer`	No	None
`scenario.plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`scenario.plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`scenario.memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`scenario.input_hash`	body	`string`	Yes	None
`scenario.created_at`	body	`string`	Yes	None
`scenario.updated_at`	body	`string \| null`	No	None
`membership`	body	`ScenarioMembershipResponse \| null`	No	None
`membership.id`	body	`string`	Yes	None
`membership.entity_id`	body	`string`	Yes	None
`membership.entity_revision`	body	`integer`	Yes	None
`membership.planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`membership.planning_snapshot.profile`	body	`EntityProfile-Output`	Yes	None
`membership.planning_snapshot.current_state`	body	`EntityCurrentState-Output \| null`	No	None
`membership.planning_snapshot.metadata`	body	`object`	No	None
`membership.introduced_at_tick`	body	`integer`	Yes	None
`membership.associated_with_id`	body	`string \| null`	No	None
`membership.initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`membership.initial_state_overrides.stats`	body	`OperationalStatsPatch`	No	None
`membership.initial_state_overrides.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	None
`membership.out_of_date`	body	`boolean`	Yes	None
`membership.removed_from_operation`	body	`boolean`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "expected_scenario_revision": 0,
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "entity": {
    "current_state": {
      "capability_states": [],
      "location": {
        "coordinates": [
          -120.5752,
          45.9037
        ],
        "type": "Point"
      },
      "stats": {
        "ammunition": 1,
        "equipment_condition": 1,
        "fatigue": 0,
        "readiness": 1
      }
    },
    "metadata": {
      "source": "maven"
    },
    "profile": {
      "affiliation": "friendly",
      "capabilities": [
        {
          "config": {
            "antenna": {
              "model": "AS3900A"
            },
            "network_name": "command",
            "operating_frequency_mhz": 40,
            "selected_power_level_id": "HI"
          },
          "id": "radio-1",
          "model": "RT1523_ASIP",
          "schema_version": 1,
          "type": "communications.radio"
        }
      ],
      "sidc": "10031000211211000000",
      "unit_name": "11 ABN"
    }
  },
  "expected_entity_revision": 0,
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {},
    "capability_states": {}
  },
  "introduced_at_tick": 0,
  "associated_with_id": "00000000-0000-0000-0000-000000000000",
  "planning_snapshot": {
    "profile": {
      "unit_name": "string",
      "sidc": "string",
      "description": {},
      "affiliation": {},
      "higher_hq": {},
      "support_priority": {},
      "capabilities": [
        {
          "config": {
            "total": 90
          },
          "id": "personnel-1",
          "model": "Assigned strength",
          "schema_version": 1,
          "type": "organization.personnel"
        },
        {
          "config": {
            "value": 33.45
          },
          "id": "power-1",
          "model": "Operational estimate",
          "schema_version": 1,
          "type": "effectiveness.power"
        },
        {
          "config": {
            "total_capacity_gallons": 1323,
            "vehicles": [
              {
                "cross_country_gallons_per_hour": 11,
                "cross_country_speed_kph": 24,
                "fuel_capacity_gallons": 63,
                "idle_gallons_per_hour": 1.2,
                "max_load_kg": 1800,
                "model": "CUSTOM-WHEELED",
                "movement_type": "Wheeled",
                "primary_road_gallons_per_hour": 6.5,
                "primary_road_speed_kph": 72,
                "quantity": 21,
                "secondary_road_gallons_per_hour": 8,
                "secondary_road_speed_kph": 48
              }
            ]
          },
          "id": "ground-mobility-1",
          "model": "CUSTOM-WHEELED-PLATOON",
          "schema_version": 1,
          "type": "mobility.ground"
        },
        {
          "config": {
            "directional": true,
            "field_of_view_degrees": 120,
            "range_km": 42
          },
          "id": "radar-1",
          "model": "CUSTOM-RADAR-X",
          "schema_version": 1,
          "type": "sensor.radar"
        },
        {
          "config": {
            "directional": true,
            "field_of_view_degrees": 70,
            "range_km": 18
          },
          "id": "sensor-1",
          "model": "CUSTOM-EOIR-X",
          "schema_version": 1,
          "type": "sensor.non_radar"
        },
        {
          "config": {
            "max_range_meters": 24000
          },
          "id": "artillery-1",
          "model": "CUSTOM-HOWITZER-X",
          "schema_version": 1,
          "type": "fires.artillery"
        },
        {
          "config": {
            "max_range_km": 180,
            "max_speed_kph": 130
          },
          "id": "uas-1",
          "model": "CUSTOM-UAS-X",
          "schema_version": 1,
          "type": "aviation.uas"
        },
        {
          "config": {
            "directional": false,
            "field_of_view_degrees": 360,
            "range_km": 12
          },
          "id": "counter-uas-1",
          "model": "CUSTOM-CUAS-X",
          "schema_version": 1,
          "type": "defense.counter_uas"
        },
        {
          "config": {
            "classification": "Small launch vehicle",
            "debris_dispersion_radius_ft": 10000,
            "inhabited_building_distance_ft": 5000,
            "public_traffic_route_distance_ft": 3000
          },
          "id": "orbital-launch-1",
          "model": "CUSTOM-LAUNCH-X",
          "schema_version": 1,
          "type": "launch.orbital"
        },
        {
          "config": {
            "fuel_consumption_gallons_per_hour": 2.5,
            "fuel_type": "JP-8"
          },
          "id": "generator-1",
          "model": "CUSTOM-GENERATOR-X",
          "schema_version": 1,
          "type": "power.generator"
        },
        {
          "config": {
            "antenna": {
              "default_height_ft": 10,
              "frequency_bands": [
                {
                  "maximum_mhz": 400,
                  "minimum_mhz": 225
                }
              ],
              "height_override_ft": 30,
              "mast_model": "CUSTOM-MAST-X",
              "mast_supported": true,
              "model": "CUSTOM-ANTENNA-X"
            },
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "network_name": "command",
            "operating_frequency_mhz": 300,
            "power_levels": [
              {
                "data_expected_range_km": 20,
                "expected_range_km": 35,
                "id": "high",
                "label": "High",
                "max_effective_range_km": {
                  "maximum": 45,
                  "minimum": 30
                },
                "planning_range_km": {
                  "maximum": 35,
                  "minimum": 25
                },
                "power_output_watts": 50
              }
            ],
            "requires_antenna": true,
            "selected_power_level_id": "high"
          },
          "id": "radio-1",
          "model": "CUSTOM-RADIO-X",
          "schema_version": 1,
          "type": "communications.radio"
        },
        {
          "config": {
            "items": [
              {
                "daily_allocation": 3,
                "id": "food-1",
                "initial_stock": 900,
                "measurement_unit": "Rations",
                "supply_type": "Food"
              },
              {
                "fuel_type": "JP-8",
                "id": "fuel-1",
                "initial_stock": 1200,
                "measurement_unit": "Gallons",
                "supply_type": "Fuel"
              },
              {
                "daily_allocation": 2,
                "id": "water-1",
                "initial_stock": 600,
                "measurement_unit": "Gallons",
                "supply_type": "Water"
              },
              {
                "id": "shelter-1",
                "initial_stock": 10,
                "measurement_unit": "Tents",
                "supply_type": "Shelter"
              }
            ]
          },
          "id": "supplies-1",
          "model": "Unit stocks",
          "schema_version": 1,
          "type": "sustainment.supplies"
        },
        {
          "config": {
            "patients": [
              {
                "id": "patient-1"
              }
            ]
          },
          "id": "medical-1",
          "model": "Patient roster",
          "schema_version": 1,
          "type": "medical.roster"
        }
      ]
    },
    "current_state": {
      "observed_at": {},
      "location": {},
      "stats": {},
      "capability_states": {}
    },
    "metadata": {}
  }
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "expected_scenario_revision": 0,
        "entity_id": "00000000-0000-0000-0000-000000000000",
        "entity": {
            "current_state": {
                "capability_states": [],
                "location": {
                    "coordinates": [
                        -120.5752,
                        45.9037
                    ],
                    "type": "Point"
                },
                "stats": {
                    "ammunition": 1,
                    "equipment_condition": 1,
                    "fatigue": 0,
                    "readiness": 1
                }
            },
            "metadata": {
                "source": "maven"
            },
            "profile": {
                "affiliation": "friendly",
                "capabilities": [
                    {
                        "config": {
                            "antenna": {
                                "model": "AS3900A"
                            },
                            "network_name": "command",
                            "operating_frequency_mhz": 40,
                            "selected_power_level_id": "HI"
                        },
                        "id": "radio-1",
                        "model": "RT1523_ASIP",
                        "schema_version": 1,
                        "type": "communications.radio"
                    }
                ],
                "sidc": "10031000211211000000",
                "unit_name": "11 ABN"
            }
        },
        "expected_entity_revision": 0,
        "current_state": {
            "observed_at": {},
            "location": {},
            "stats": {},
            "capability_states": {}
        },
        "introduced_at_tick": 0,
        "associated_with_id": "00000000-0000-0000-0000-000000000000",
        "planning_snapshot": {
            "profile": {
                "unit_name": "string",
                "sidc": "string",
                "description": {},
                "affiliation": {},
                "higher_hq": {},
                "support_priority": {},
                "capabilities": [
                    {
                        "config": {
                            "total": 90
                        },
                        "id": "personnel-1",
                        "model": "Assigned strength",
                        "schema_version": 1,
                        "type": "organization.personnel"
                    },
                    {
                        "config": {
                            "value": 33.45
                        },
                        "id": "power-1",
                        "model": "Operational estimate",
                        "schema_version": 1,
                        "type": "effectiveness.power"
                    },
                    {
                        "config": {
                            "total_capacity_gallons": 1323,
                            "vehicles": [
                                {
                                    "cross_country_gallons_per_hour": 11,
                                    "cross_country_speed_kph": 24,
                                    "fuel_capacity_gallons": 63,
                                    "idle_gallons_per_hour": 1.2,
                                    "max_load_kg": 1800,
                                    "model": "CUSTOM-WHEELED",
                                    "movement_type": "Wheeled",
                                    "primary_road_gallons_per_hour": 6.5,
                                    "primary_road_speed_kph": 72,
                                    "quantity": 21,
                                    "secondary_road_gallons_per_hour": 8,
                                    "secondary_road_speed_kph": 48
                                }
                            ]
                        },
                        "id": "ground-mobility-1",
                        "model": "CUSTOM-WHEELED-PLATOON",
                        "schema_version": 1,
                        "type": "mobility.ground"
                    },
                    {
                        "config": {
                            "directional": true,
                            "field_of_view_degrees": 120,
                            "range_km": 42
                        },
                        "id": "radar-1",
                        "model": "CUSTOM-RADAR-X",
                        "schema_version": 1,
                        "type": "sensor.radar"
                    },
                    {
                        "config": {
                            "directional": true,
                            "field_of_view_degrees": 70,
                            "range_km": 18
                        },
                        "id": "sensor-1",
                        "model": "CUSTOM-EOIR-X",
                        "schema_version": 1,
                        "type": "sensor.non_radar"
                    },
                    {
                        "config": {
                            "max_range_meters": 24000
                        },
                        "id": "artillery-1",
                        "model": "CUSTOM-HOWITZER-X",
                        "schema_version": 1,
                        "type": "fires.artillery"
                    },
                    {
                        "config": {
                            "max_range_km": 180,
                            "max_speed_kph": 130
                        },
                        "id": "uas-1",
                        "model": "CUSTOM-UAS-X",
                        "schema_version": 1,
                        "type": "aviation.uas"
                    },
                    {
                        "config": {
                            "directional": false,
                            "field_of_view_degrees": 360,
                            "range_km": 12
                        },
                        "id": "counter-uas-1",
                        "model": "CUSTOM-CUAS-X",
                        "schema_version": 1,
                        "type": "defense.counter_uas"
                    },
                    {
                        "config": {
                            "classification": "Small launch vehicle",
                            "debris_dispersion_radius_ft": 10000,
                            "inhabited_building_distance_ft": 5000,
                            "public_traffic_route_distance_ft": 3000
                        },
                        "id": "orbital-launch-1",
                        "model": "CUSTOM-LAUNCH-X",
                        "schema_version": 1,
                        "type": "launch.orbital"
                    },
                    {
                        "config": {
                            "fuel_consumption_gallons_per_hour": 2.5,
                            "fuel_type": "JP-8"
                        },
                        "id": "generator-1",
                        "model": "CUSTOM-GENERATOR-X",
                        "schema_version": 1,
                        "type": "power.generator"
                    },
                    {
                        "config": {
                            "antenna": {
                                "default_height_ft": 10,
                                "frequency_bands": [
                                    {
                                        "maximum_mhz": 400,
                                        "minimum_mhz": 225
                                    }
                                ],
                                "height_override_ft": 30,
                                "mast_model": "CUSTOM-MAST-X",
                                "mast_supported": true,
                                "model": "CUSTOM-ANTENNA-X"
                            },
                            "frequency_bands": [
                                {
                                    "maximum_mhz": 400,
                                    "minimum_mhz": 225
                                }
                            ],
                            "network_name": "command",
                            "operating_frequency_mhz": 300,
                            "power_levels": [
                                {
                                    "data_expected_range_km": 20,
                                    "expected_range_km": 35,
                                    "id": "high",
                                    "label": "High",
                                    "max_effective_range_km": {
                                        "maximum": 45,
                                        "minimum": 30
                                    },
                                    "planning_range_km": {
                                        "maximum": 35,
                                        "minimum": 25
                                    },
                                    "power_output_watts": 50
                                }
                            ],
                            "requires_antenna": true,
                            "selected_power_level_id": "high"
                        },
                        "id": "radio-1",
                        "model": "CUSTOM-RADIO-X",
                        "schema_version": 1,
                        "type": "communications.radio"
                    },
                    {
                        "config": {
                            "items": [
                                {
                                    "daily_allocation": 3,
                                    "id": "food-1",
                                    "initial_stock": 900,
                                    "measurement_unit": "Rations",
                                    "supply_type": "Food"
                                },
                                {
                                    "fuel_type": "JP-8",
                                    "id": "fuel-1",
                                    "initial_stock": 1200,
                                    "measurement_unit": "Gallons",
                                    "supply_type": "Fuel"
                                },
                                {
                                    "daily_allocation": 2,
                                    "id": "water-1",
                                    "initial_stock": 600,
                                    "measurement_unit": "Gallons",
                                    "supply_type": "Water"
                                },
                                {
                                    "id": "shelter-1",
                                    "initial_stock": 10,
                                    "measurement_unit": "Tents",
                                    "supply_type": "Shelter"
                                }
                            ]
                        },
                        "id": "supplies-1",
                        "model": "Unit stocks",
                        "schema_version": 1,
                        "type": "sustainment.supplies"
                    },
                    {
                        "config": {
                            "patients": [
                                {
                                    "id": "patient-1"
                                }
                            ]
                        },
                        "id": "medical-1",
                        "model": "Patient roster",
                        "schema_version": 1,
                        "type": "medical.roster"
                    }
                ]
            },
            "current_state": {
                "observed_at": {},
                "location": {},
                "stats": {},
                "capability_states": {}
            },
            "metadata": {}
        }
    },
)
print(response.json())

Example response

{
  "scenario": {
    "id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "schema_version": 0,
    "revision": 0,
    "starts_at": "2026-06-01T00:00:00Z",
    "snapshot_duration_hours": 0,
    "plan": {
      "schema_version": 2,
      "capability_resolver_version": "2",
      "ticks": [
        {}
      ]
    }
  },
  "membership": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000",
    "entity_revision": 0,
    "planning_snapshot": {
      "profile": {},
      "current_state": {},
      "metadata": {}
    },
    "introduced_at_tick": 0,
    "associated_with_id": {},
    "initial_state_overrides": {
      "stats": {},
      "capability_states": {}
    },
    "out_of_date": true
  }
}

PATCH/api/scenarios/{scenario_id}/entities/{entity_id}Scenariorouter.Update Scenario Entity

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`expected_scenario_revision`	body	`integer \| null`	No	None
`introduced_at_tick`	body	`integer \| null`	No	None
`associated_with_id`	body	`string \| null`	No	None
`initial_state_overrides`	body	`ScenarioInitialStateOverrides-Input \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioMembershipMutationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioMembershipMutationResponse

Name	In	Type	Required	Description
`scenario`	body	`ScenarioV2Response`	Yes	None
`scenario.id`	body	`string`	Yes	None
`scenario.map_id`	body	`string`	Yes	None
`scenario.name`	body	`string`	Yes	None
`scenario.schema_version`	body	`integer`	Yes	None
`scenario.revision`	body	`integer`	Yes	None
`scenario.starts_at`	body	`string`	Yes	None
`scenario.snapshot_duration_hours`	body	`number`	Yes	None
`scenario.plan`	body	`ScenarioPlanV2-Output`	Yes	None
`scenario.plan.schema_version`	body	`integer`	No	None
`scenario.plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`scenario.plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`scenario.memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`scenario.input_hash`	body	`string`	Yes	None
`scenario.created_at`	body	`string`	Yes	None
`scenario.updated_at`	body	`string \| null`	No	None
`membership`	body	`ScenarioMembershipResponse \| null`	No	None
`membership.id`	body	`string`	Yes	None
`membership.entity_id`	body	`string`	Yes	None
`membership.entity_revision`	body	`integer`	Yes	None
`membership.planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`membership.planning_snapshot.profile`	body	`EntityProfile-Output`	Yes	None
`membership.planning_snapshot.current_state`	body	`EntityCurrentState-Output \| null`	No	None
`membership.planning_snapshot.metadata`	body	`object`	No	None
`membership.introduced_at_tick`	body	`integer`	Yes	None
`membership.associated_with_id`	body	`string \| null`	No	None
`membership.initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`membership.initial_state_overrides.stats`	body	`OperationalStatsPatch`	No	None
`membership.initial_state_overrides.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	None
`membership.out_of_date`	body	`boolean`	Yes	None
`membership.removed_from_operation`	body	`boolean`	Yes	None

Language

ShellPython

Shell

curl -X PATCH "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "expected_scenario_revision": 0,
  "introduced_at_tick": 0,
  "associated_with_id": "00000000-0000-0000-0000-000000000000",
  "initial_state_overrides": {
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  }
}'

Python

import requests

response = requests.patch(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "expected_scenario_revision": 0,
        "introduced_at_tick": 0,
        "associated_with_id": "00000000-0000-0000-0000-000000000000",
        "initial_state_overrides": {
            "stats": {
                "readiness": {},
                "equipment_condition": {},
                "ammunition": {},
                "fatigue": {}
            },
            "capability_states": [
                {}
            ]
        }
    },
)
print(response.json())

Example response

{
  "scenario": {
    "id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "schema_version": 0,
    "revision": 0,
    "starts_at": "2026-06-01T00:00:00Z",
    "snapshot_duration_hours": 0,
    "plan": {
      "schema_version": 2,
      "capability_resolver_version": "2",
      "ticks": [
        {}
      ]
    }
  },
  "membership": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000",
    "entity_revision": 0,
    "planning_snapshot": {
      "profile": {},
      "current_state": {},
      "metadata": {}
    },
    "introduced_at_tick": 0,
    "associated_with_id": {},
    "initial_state_overrides": {
      "stats": {},
      "capability_states": {}
    },
    "out_of_date": true
  }
}

DELETE/api/scenarios/{scenario_id}/entities/{entity_id}Scenariorouter.Remove Scenario Entity

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`expected_scenario_revision`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioMembershipMutationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioMembershipMutationResponse

Name	In	Type	Required	Description
`scenario`	body	`ScenarioV2Response`	Yes	None
`scenario.id`	body	`string`	Yes	None
`scenario.map_id`	body	`string`	Yes	None
`scenario.name`	body	`string`	Yes	None
`scenario.schema_version`	body	`integer`	Yes	None
`scenario.revision`	body	`integer`	Yes	None
`scenario.starts_at`	body	`string`	Yes	None
`scenario.snapshot_duration_hours`	body	`number`	Yes	None
`scenario.plan`	body	`ScenarioPlanV2-Output`	Yes	None
`scenario.plan.schema_version`	body	`integer`	No	None
`scenario.plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`scenario.plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`scenario.memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`scenario.input_hash`	body	`string`	Yes	None
`scenario.created_at`	body	`string`	Yes	None
`scenario.updated_at`	body	`string \| null`	No	None
`membership`	body	`ScenarioMembershipResponse \| null`	No	None
`membership.id`	body	`string`	Yes	None
`membership.entity_id`	body	`string`	Yes	None
`membership.entity_revision`	body	`integer`	Yes	None
`membership.planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`membership.planning_snapshot.profile`	body	`EntityProfile-Output`	Yes	None
`membership.planning_snapshot.current_state`	body	`EntityCurrentState-Output \| null`	No	None
`membership.planning_snapshot.metadata`	body	`object`	No	None
`membership.introduced_at_tick`	body	`integer`	Yes	None
`membership.associated_with_id`	body	`string \| null`	No	None
`membership.initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`membership.initial_state_overrides.stats`	body	`OperationalStatsPatch`	No	None
`membership.initial_state_overrides.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	None
`membership.out_of_date`	body	`boolean`	Yes	None
`membership.removed_from_operation`	body	`boolean`	Yes	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>?expected_scenario_revision=<expected_scenario_revision>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "scenario": {
    "id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "schema_version": 0,
    "revision": 0,
    "starts_at": "2026-06-01T00:00:00Z",
    "snapshot_duration_hours": 0,
    "plan": {
      "schema_version": 2,
      "capability_resolver_version": "2",
      "ticks": [
        {}
      ]
    }
  },
  "membership": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000",
    "entity_revision": 0,
    "planning_snapshot": {
      "profile": {},
      "current_state": {},
      "metadata": {}
    },
    "introduced_at_tick": 0,
    "associated_with_id": {},
    "initial_state_overrides": {
      "stats": {},
      "capability_states": {}
    },
    "out_of_date": true
  }
}

PATCH/api/scenarios/{scenario_id}/entities/{entity_id}/canonicalScenariorouter.Patch Canonical Scenario Entity

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`expected_scenario_revision`	body	`integer \| null`	No	None
`expected_entity_revision`	body	`integer \| null`	No	None
`profile`	body	`EntityProfilePatch \| null`	No	None
`current_state`	body	`EntityCurrentStatePatch \| null`	No	None
`metadata`	body	`object \| null`	No	None
`planning_snapshot`	body	`ScenarioPlanningSnapshot-Input \| null`	No	None
`initial_state_overrides`	body	`ScenarioInitialStateOverrides-Input \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioMembershipMutationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioMembershipMutationResponse

Name	In	Type	Required	Description
`scenario`	body	`ScenarioV2Response`	Yes	None
`scenario.id`	body	`string`	Yes	None
`scenario.map_id`	body	`string`	Yes	None
`scenario.name`	body	`string`	Yes	None
`scenario.schema_version`	body	`integer`	Yes	None
`scenario.revision`	body	`integer`	Yes	None
`scenario.starts_at`	body	`string`	Yes	None
`scenario.snapshot_duration_hours`	body	`number`	Yes	None
`scenario.plan`	body	`ScenarioPlanV2-Output`	Yes	None
`scenario.plan.schema_version`	body	`integer`	No	None
`scenario.plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`scenario.plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`scenario.memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`scenario.input_hash`	body	`string`	Yes	None
`scenario.created_at`	body	`string`	Yes	None
`scenario.updated_at`	body	`string \| null`	No	None
`membership`	body	`ScenarioMembershipResponse \| null`	No	None
`membership.id`	body	`string`	Yes	None
`membership.entity_id`	body	`string`	Yes	None
`membership.entity_revision`	body	`integer`	Yes	None
`membership.planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`membership.planning_snapshot.profile`	body	`EntityProfile-Output`	Yes	None
`membership.planning_snapshot.current_state`	body	`EntityCurrentState-Output \| null`	No	None
`membership.planning_snapshot.metadata`	body	`object`	No	None
`membership.introduced_at_tick`	body	`integer`	Yes	None
`membership.associated_with_id`	body	`string \| null`	No	None
`membership.initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`membership.initial_state_overrides.stats`	body	`OperationalStatsPatch`	No	None
`membership.initial_state_overrides.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	None
`membership.out_of_date`	body	`boolean`	Yes	None
`membership.removed_from_operation`	body	`boolean`	Yes	None

Language

ShellPython

Shell

curl -X PATCH "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>/canonical" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "expected_scenario_revision": 0,
  "expected_entity_revision": 0,
  "profile": {
    "unit_name": {},
    "sidc": {},
    "description": {},
    "affiliation": {},
    "higher_hq": {},
    "support_priority": {},
    "capabilities": {}
  },
  "current_state": {
    "observed_at": {},
    "location": {},
    "stats": {},
    "capability_states": {}
  },
  "metadata": {},
  "planning_snapshot": {
    "profile": {
      "unit_name": {},
      "sidc": {},
      "description": {},
      "affiliation": {},
      "higher_hq": {},
      "support_priority": {},
      "capabilities": {}
    },
    "current_state": {},
    "metadata": {}
  },
  "initial_state_overrides": {
    "stats": {
      "readiness": {},
      "equipment_condition": {},
      "ammunition": {},
      "fatigue": {}
    },
    "capability_states": [
      {}
    ]
  }
}'

Python

import requests

response = requests.patch(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>/canonical",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "expected_scenario_revision": 0,
        "expected_entity_revision": 0,
        "profile": {
            "unit_name": {},
            "sidc": {},
            "description": {},
            "affiliation": {},
            "higher_hq": {},
            "support_priority": {},
            "capabilities": {}
        },
        "current_state": {
            "observed_at": {},
            "location": {},
            "stats": {},
            "capability_states": {}
        },
        "metadata": {},
        "planning_snapshot": {
            "profile": {
                "unit_name": {},
                "sidc": {},
                "description": {},
                "affiliation": {},
                "higher_hq": {},
                "support_priority": {},
                "capabilities": {}
            },
            "current_state": {},
            "metadata": {}
        },
        "initial_state_overrides": {
            "stats": {
                "readiness": {},
                "equipment_condition": {},
                "ammunition": {},
                "fatigue": {}
            },
            "capability_states": [
                {}
            ]
        }
    },
)
print(response.json())

Example response

{
  "scenario": {
    "id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "schema_version": 0,
    "revision": 0,
    "starts_at": "2026-06-01T00:00:00Z",
    "snapshot_duration_hours": 0,
    "plan": {
      "schema_version": 2,
      "capability_resolver_version": "2",
      "ticks": [
        {}
      ]
    }
  },
  "membership": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000",
    "entity_revision": 0,
    "planning_snapshot": {
      "profile": {},
      "current_state": {},
      "metadata": {}
    },
    "introduced_at_tick": 0,
    "associated_with_id": {},
    "initial_state_overrides": {
      "stats": {},
      "capability_states": {}
    },
    "out_of_date": true
  }
}

POST/api/scenarios/{scenario_id}/entities/{entity_id}/rebaseScenariorouter.Rebase Scenario Entity

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`entity_id`	path	`string`	Yes	None
`expected_scenario_revision`	body	`integer \| null`	No	None
`expected_entity_revision`	body	`integer \| null`	No	None
`planning_snapshot`	body	`ScenarioPlanningSnapshot-Input`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioMembershipMutationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioMembershipMutationResponse

Name	In	Type	Required	Description
`scenario`	body	`ScenarioV2Response`	Yes	None
`scenario.id`	body	`string`	Yes	None
`scenario.map_id`	body	`string`	Yes	None
`scenario.name`	body	`string`	Yes	None
`scenario.schema_version`	body	`integer`	Yes	None
`scenario.revision`	body	`integer`	Yes	None
`scenario.starts_at`	body	`string`	Yes	None
`scenario.snapshot_duration_hours`	body	`number`	Yes	None
`scenario.plan`	body	`ScenarioPlanV2-Output`	Yes	None
`scenario.plan.schema_version`	body	`integer`	No	None
`scenario.plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`scenario.plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`scenario.memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`scenario.input_hash`	body	`string`	Yes	None
`scenario.created_at`	body	`string`	Yes	None
`scenario.updated_at`	body	`string \| null`	No	None
`membership`	body	`ScenarioMembershipResponse \| null`	No	None
`membership.id`	body	`string`	Yes	None
`membership.entity_id`	body	`string`	Yes	None
`membership.entity_revision`	body	`integer`	Yes	None
`membership.planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`membership.planning_snapshot.profile`	body	`EntityProfile-Output`	Yes	None
`membership.planning_snapshot.current_state`	body	`EntityCurrentState-Output \| null`	No	None
`membership.planning_snapshot.metadata`	body	`object`	No	None
`membership.introduced_at_tick`	body	`integer`	Yes	None
`membership.associated_with_id`	body	`string \| null`	No	None
`membership.initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`membership.initial_state_overrides.stats`	body	`OperationalStatsPatch`	No	None
`membership.initial_state_overrides.capability_states`	body	`array<GroundMobilityState \| SuppliesState-Output \| MedicalRosterState-Output>`	No	None
`membership.out_of_date`	body	`boolean`	Yes	None
`membership.removed_from_operation`	body	`boolean`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>/rebase" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "expected_scenario_revision": 0,
  "expected_entity_revision": 0,
  "planning_snapshot": {
    "profile": {
      "unit_name": "string",
      "sidc": "string",
      "description": {},
      "affiliation": {},
      "higher_hq": {},
      "support_priority": {},
      "capabilities": [
        {
          "config": {
            "total": 90
          },
          "id": "personnel-1",
          "model": "Assigned strength",
          "schema_version": 1,
          "type": "organization.personnel"
        },
        {
          "config": {
            "value": 33.45
          },
          "id": "power-1",
          "model": "Operational estimate",
          "schema_version": 1,
          "type": "effectiveness.power"
        },
        {
          "config": {
            "total_capacity_gallons": 1323,
            "vehicles": [
              {
                "cross_country_gallons_per_hour": 11,
                "cross_country_speed_kph": 24,
                "fuel_capacity_gallons": 63,
                "idle_gallons_per_hour": 1.2,
                "max_load_kg": 1800,
                "model": "CUSTOM-WHEELED",
                "movement_type": "Wheeled",
                "primary_road_gallons_per_hour": 6.5,
                "primary_road_speed_kph": 72,
                "quantity": 21,
                "secondary_road_gallons_per_hour": 8,
                "secondary_road_speed_kph": 48
              }
            ]
          },
          "id": "ground-mobility-1",
          "model": "CUSTOM-WHEELED-PLATOON",
          "schema_version": 1,
          "type": "mobility.ground"
        },
        {
          "config": {
            "directional": true,
            "field_of_view_degrees": 120,
            "range_km": 42
          },
          "id": "radar-1",
          "model": "CUSTOM-RADAR-X",
          "schema_version": 1,
          "type": "sensor.radar"
        },
        {
          "config": {
            "directional": true,
            "field_of_view_degrees": 70,
            "range_km": 18
          },
          "id": "sensor-1",
          "model": "CUSTOM-EOIR-X",
          "schema_version": 1,
          "type": "sensor.non_radar"
        },
        {
          "config": {
            "max_range_meters": 24000
          },
          "id": "artillery-1",
          "model": "CUSTOM-HOWITZER-X",
          "schema_version": 1,
          "type": "fires.artillery"
        },
        {
          "config": {
            "max_range_km": 180,
            "max_speed_kph": 130
          },
          "id": "uas-1",
          "model": "CUSTOM-UAS-X",
          "schema_version": 1,
          "type": "aviation.uas"
        },
        {
          "config": {
            "directional": false,
            "field_of_view_degrees": 360,
            "range_km": 12
          },
          "id": "counter-uas-1",
          "model": "CUSTOM-CUAS-X",
          "schema_version": 1,
          "type": "defense.counter_uas"
        },
        {
          "config": {
            "classification": "Small launch vehicle",
            "debris_dispersion_radius_ft": 10000,
            "inhabited_building_distance_ft": 5000,
            "public_traffic_route_distance_ft": 3000
          },
          "id": "orbital-launch-1",
          "model": "CUSTOM-LAUNCH-X",
          "schema_version": 1,
          "type": "launch.orbital"
        },
        {
          "config": {
            "fuel_consumption_gallons_per_hour": 2.5,
            "fuel_type": "JP-8"
          },
          "id": "generator-1",
          "model": "CUSTOM-GENERATOR-X",
          "schema_version": 1,
          "type": "power.generator"
        },
        {
          "config": {
            "antenna": {
              "default_height_ft": 10,
              "frequency_bands": [
                {
                  "maximum_mhz": 400,
                  "minimum_mhz": 225
                }
              ],
              "height_override_ft": 30,
              "mast_model": "CUSTOM-MAST-X",
              "mast_supported": true,
              "model": "CUSTOM-ANTENNA-X"
            },
            "frequency_bands": [
              {
                "maximum_mhz": 400,
                "minimum_mhz": 225
              }
            ],
            "network_name": "command",
            "operating_frequency_mhz": 300,
            "power_levels": [
              {
                "data_expected_range_km": 20,
                "expected_range_km": 35,
                "id": "high",
                "label": "High",
                "max_effective_range_km": {
                  "maximum": 45,
                  "minimum": 30
                },
                "planning_range_km": {
                  "maximum": 35,
                  "minimum": 25
                },
                "power_output_watts": 50
              }
            ],
            "requires_antenna": true,
            "selected_power_level_id": "high"
          },
          "id": "radio-1",
          "model": "CUSTOM-RADIO-X",
          "schema_version": 1,
          "type": "communications.radio"
        },
        {
          "config": {
            "items": [
              {
                "daily_allocation": 3,
                "id": "food-1",
                "initial_stock": 900,
                "measurement_unit": "Rations",
                "supply_type": "Food"
              },
              {
                "fuel_type": "JP-8",
                "id": "fuel-1",
                "initial_stock": 1200,
                "measurement_unit": "Gallons",
                "supply_type": "Fuel"
              },
              {
                "daily_allocation": 2,
                "id": "water-1",
                "initial_stock": 600,
                "measurement_unit": "Gallons",
                "supply_type": "Water"
              },
              {
                "id": "shelter-1",
                "initial_stock": 10,
                "measurement_unit": "Tents",
                "supply_type": "Shelter"
              }
            ]
          },
          "id": "supplies-1",
          "model": "Unit stocks",
          "schema_version": 1,
          "type": "sustainment.supplies"
        },
        {
          "config": {
            "patients": [
              {
                "id": "patient-1"
              }
            ]
          },
          "id": "medical-1",
          "model": "Patient roster",
          "schema_version": 1,
          "type": "medical.roster"
        }
      ]
    },
    "current_state": {
      "observed_at": {},
      "location": {},
      "stats": {},
      "capability_states": {}
    },
    "metadata": {}
  }
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/entities/<entity_id>/rebase",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "expected_scenario_revision": 0,
        "expected_entity_revision": 0,
        "planning_snapshot": {
            "profile": {
                "unit_name": "string",
                "sidc": "string",
                "description": {},
                "affiliation": {},
                "higher_hq": {},
                "support_priority": {},
                "capabilities": [
                    {
                        "config": {
                            "total": 90
                        },
                        "id": "personnel-1",
                        "model": "Assigned strength",
                        "schema_version": 1,
                        "type": "organization.personnel"
                    },
                    {
                        "config": {
                            "value": 33.45
                        },
                        "id": "power-1",
                        "model": "Operational estimate",
                        "schema_version": 1,
                        "type": "effectiveness.power"
                    },
                    {
                        "config": {
                            "total_capacity_gallons": 1323,
                            "vehicles": [
                                {
                                    "cross_country_gallons_per_hour": 11,
                                    "cross_country_speed_kph": 24,
                                    "fuel_capacity_gallons": 63,
                                    "idle_gallons_per_hour": 1.2,
                                    "max_load_kg": 1800,
                                    "model": "CUSTOM-WHEELED",
                                    "movement_type": "Wheeled",
                                    "primary_road_gallons_per_hour": 6.5,
                                    "primary_road_speed_kph": 72,
                                    "quantity": 21,
                                    "secondary_road_gallons_per_hour": 8,
                                    "secondary_road_speed_kph": 48
                                }
                            ]
                        },
                        "id": "ground-mobility-1",
                        "model": "CUSTOM-WHEELED-PLATOON",
                        "schema_version": 1,
                        "type": "mobility.ground"
                    },
                    {
                        "config": {
                            "directional": true,
                            "field_of_view_degrees": 120,
                            "range_km": 42
                        },
                        "id": "radar-1",
                        "model": "CUSTOM-RADAR-X",
                        "schema_version": 1,
                        "type": "sensor.radar"
                    },
                    {
                        "config": {
                            "directional": true,
                            "field_of_view_degrees": 70,
                            "range_km": 18
                        },
                        "id": "sensor-1",
                        "model": "CUSTOM-EOIR-X",
                        "schema_version": 1,
                        "type": "sensor.non_radar"
                    },
                    {
                        "config": {
                            "max_range_meters": 24000
                        },
                        "id": "artillery-1",
                        "model": "CUSTOM-HOWITZER-X",
                        "schema_version": 1,
                        "type": "fires.artillery"
                    },
                    {
                        "config": {
                            "max_range_km": 180,
                            "max_speed_kph": 130
                        },
                        "id": "uas-1",
                        "model": "CUSTOM-UAS-X",
                        "schema_version": 1,
                        "type": "aviation.uas"
                    },
                    {
                        "config": {
                            "directional": false,
                            "field_of_view_degrees": 360,
                            "range_km": 12
                        },
                        "id": "counter-uas-1",
                        "model": "CUSTOM-CUAS-X",
                        "schema_version": 1,
                        "type": "defense.counter_uas"
                    },
                    {
                        "config": {
                            "classification": "Small launch vehicle",
                            "debris_dispersion_radius_ft": 10000,
                            "inhabited_building_distance_ft": 5000,
                            "public_traffic_route_distance_ft": 3000
                        },
                        "id": "orbital-launch-1",
                        "model": "CUSTOM-LAUNCH-X",
                        "schema_version": 1,
                        "type": "launch.orbital"
                    },
                    {
                        "config": {
                            "fuel_consumption_gallons_per_hour": 2.5,
                            "fuel_type": "JP-8"
                        },
                        "id": "generator-1",
                        "model": "CUSTOM-GENERATOR-X",
                        "schema_version": 1,
                        "type": "power.generator"
                    },
                    {
                        "config": {
                            "antenna": {
                                "default_height_ft": 10,
                                "frequency_bands": [
                                    {
                                        "maximum_mhz": 400,
                                        "minimum_mhz": 225
                                    }
                                ],
                                "height_override_ft": 30,
                                "mast_model": "CUSTOM-MAST-X",
                                "mast_supported": true,
                                "model": "CUSTOM-ANTENNA-X"
                            },
                            "frequency_bands": [
                                {
                                    "maximum_mhz": 400,
                                    "minimum_mhz": 225
                                }
                            ],
                            "network_name": "command",
                            "operating_frequency_mhz": 300,
                            "power_levels": [
                                {
                                    "data_expected_range_km": 20,
                                    "expected_range_km": 35,
                                    "id": "high",
                                    "label": "High",
                                    "max_effective_range_km": {
                                        "maximum": 45,
                                        "minimum": 30
                                    },
                                    "planning_range_km": {
                                        "maximum": 35,
                                        "minimum": 25
                                    },
                                    "power_output_watts": 50
                                }
                            ],
                            "requires_antenna": true,
                            "selected_power_level_id": "high"
                        },
                        "id": "radio-1",
                        "model": "CUSTOM-RADIO-X",
                        "schema_version": 1,
                        "type": "communications.radio"
                    },
                    {
                        "config": {
                            "items": [
                                {
                                    "daily_allocation": 3,
                                    "id": "food-1",
                                    "initial_stock": 900,
                                    "measurement_unit": "Rations",
                                    "supply_type": "Food"
                                },
                                {
                                    "fuel_type": "JP-8",
                                    "id": "fuel-1",
                                    "initial_stock": 1200,
                                    "measurement_unit": "Gallons",
                                    "supply_type": "Fuel"
                                },
                                {
                                    "daily_allocation": 2,
                                    "id": "water-1",
                                    "initial_stock": 600,
                                    "measurement_unit": "Gallons",
                                    "supply_type": "Water"
                                },
                                {
                                    "id": "shelter-1",
                                    "initial_stock": 10,
                                    "measurement_unit": "Tents",
                                    "supply_type": "Shelter"
                                }
                            ]
                        },
                        "id": "supplies-1",
                        "model": "Unit stocks",
                        "schema_version": 1,
                        "type": "sustainment.supplies"
                    },
                    {
                        "config": {
                            "patients": [
                                {
                                    "id": "patient-1"
                                }
                            ]
                        },
                        "id": "medical-1",
                        "model": "Patient roster",
                        "schema_version": 1,
                        "type": "medical.roster"
                    }
                ]
            },
            "current_state": {
                "observed_at": {},
                "location": {},
                "stats": {},
                "capability_states": {}
            },
            "metadata": {}
        }
    },
)
print(response.json())

Example response

{
  "scenario": {
    "id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "schema_version": 0,
    "revision": 0,
    "starts_at": "2026-06-01T00:00:00Z",
    "snapshot_duration_hours": 0,
    "plan": {
      "schema_version": 2,
      "capability_resolver_version": "2",
      "ticks": [
        {}
      ]
    }
  },
  "membership": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entity_id": "00000000-0000-0000-0000-000000000000",
    "entity_revision": 0,
    "planning_snapshot": {
      "profile": {},
      "current_state": {},
      "metadata": {}
    },
    "introduced_at_tick": 0,
    "associated_with_id": {},
    "initial_state_overrides": {
      "stats": {},
      "capability_states": {}
    },
    "out_of_date": true
  }
}

POST/api/scenarios/{scenario_id}/export-sync-matrixScenariorouter.Export Sync Matrix

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/export-sync-matrix" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/export-sync-matrix",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/scenarios/{scenario_id}/v2Scenariorouter.Get Scenario V2

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioV2Response`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioV2Response

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`schema_version`	body	`integer`	Yes	None
`revision`	body	`integer`	Yes	None
`starts_at`	body	`string`	Yes	None
`snapshot_duration_hours`	body	`number`	Yes	None
`plan`	body	`ScenarioPlanV2-Output`	Yes	None
`plan.schema_version`	body	`integer`	No	None
`plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`memberships[].id`	body	`string`	Yes	None
`memberships[].entity_id`	body	`string`	Yes	None
`memberships[].entity_revision`	body	`integer`	Yes	None
`memberships[].planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`memberships[].introduced_at_tick`	body	`integer`	Yes	None
`memberships[].associated_with_id`	body	`string \| null`	No	None
`memberships[].initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`memberships[].out_of_date`	body	`boolean`	Yes	None
`memberships[].removed_from_operation`	body	`boolean`	Yes	None
`input_hash`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "schema_version": 0,
  "revision": 0,
  "starts_at": "2026-06-01T00:00:00Z",
  "snapshot_duration_hours": 0,
  "plan": {
    "schema_version": 2,
    "capability_resolver_version": "2",
    "ticks": [
      {
        "order": {},
        "entity_changes": {},
        "engagements": {}
      }
    ]
  }
}

PUT/api/scenarios/{scenario_id}/v2Scenariorouter.Update Scenario V2

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`expected_revision`	body	`integer \| null`	No	None
`name`	body	`string \| null`	No	None
`plan`	body	`ScenarioPlanV2-Input`	Yes	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number \| null`	No	None
`deleted_tick`	body	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ScenarioV2Response`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonScenarioV2Response

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`schema_version`	body	`integer`	Yes	None
`revision`	body	`integer`	Yes	None
`starts_at`	body	`string`	Yes	None
`snapshot_duration_hours`	body	`number`	Yes	None
`plan`	body	`ScenarioPlanV2-Output`	Yes	None
`plan.schema_version`	body	`integer`	No	None
`plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`memberships[].id`	body	`string`	Yes	None
`memberships[].entity_id`	body	`string`	Yes	None
`memberships[].entity_revision`	body	`integer`	Yes	None
`memberships[].planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`memberships[].introduced_at_tick`	body	`integer`	Yes	None
`memberships[].associated_with_id`	body	`string \| null`	No	None
`memberships[].initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`memberships[].out_of_date`	body	`boolean`	Yes	None
`memberships[].removed_from_operation`	body	`boolean`	Yes	None
`input_hash`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "expected_revision": 0,
  "name": "string",
  "plan": {
    "schema_version": 2,
    "capability_resolver_version": "2",
    "ticks": [
      {
        "order": {},
        "entity_changes": {},
        "engagements": {}
      }
    ]
  },
  "starts_at": "2026-06-01T00:00:00Z",
  "snapshot_duration_hours": 0,
  "deleted_tick": 0
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "expected_revision": 0,
        "name": "string",
        "plan": {
            "schema_version": 2,
            "capability_resolver_version": "2",
            "ticks": [
                {
                    "order": {},
                    "entity_changes": {},
                    "engagements": {}
                }
            ]
        },
        "starts_at": "2026-06-01T00:00:00Z",
        "snapshot_duration_hours": 0,
        "deleted_tick": 0
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "schema_version": 0,
  "revision": 0,
  "starts_at": "2026-06-01T00:00:00Z",
  "snapshot_duration_hours": 0,
  "plan": {
    "schema_version": 2,
    "capability_resolver_version": "2",
    "ticks": [
      {
        "order": {},
        "entity_changes": {},
        "engagements": {}
      }
    ]
  }
}

PUT/api/scenarios/{scenario_id}/v2/calculation-artifactScenariorouter.Put Calculation Artifact

Parameters

Name	In	Type	Required	Description
`scenario_id`	path	`string`	Yes	None
`input_hash`	body	`string`	Yes	None
`schema_version`	body	`integer`	No	None
`artifact`	body	`CalculationArtifact`	Yes	None

Responses

Name	In	Type	Required	Description
`204`	response	`unknown`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2/calculation-artifact" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "input_hash": "string",
  "schema_version": 1,
  "artifact": {
    "entity_definitions": [
      {}
    ],
    "snapshots": [
      {}
    ],
    "snapshot_duration_hours": 0
  }
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/scenarios/<scenario_id>/v2/calculation-artifact",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "input_hash": "string",
        "schema_version": 1,
        "artifact": {
            "entity_definitions": [
                {}
            ],
            "snapshots": [
                {}
            ],
            "snapshot_duration_hours": 0
        }
    },
)
print(response.json())

Example response

{}

POST/api/scenarios/v2Scenariorouter.Create V2

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`name`	body	`string`	No	None
`starts_at`	body	`string \| null`	No	None
`snapshot_duration_hours`	body	`number`	No	None

Responses

Name	In	Type	Required	Description
`201`	application/json	`ScenarioV2Response`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

201application/jsonScenarioV2Response

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`map_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`schema_version`	body	`integer`	Yes	None
`revision`	body	`integer`	Yes	None
`starts_at`	body	`string`	Yes	None
`snapshot_duration_hours`	body	`number`	Yes	None
`plan`	body	`ScenarioPlanV2-Output`	Yes	None
`plan.schema_version`	body	`integer`	No	None
`plan.capability_resolver_version`	body	`string`	No	Version of the frontend capability resolver/default set used to materialize the plan.
`plan.ticks`	body	`array<ScenarioTickDelta-Output>`	No	None
`memberships`	body	`array<ScenarioMembershipResponse>`	Yes	None
`memberships[].id`	body	`string`	Yes	None
`memberships[].entity_id`	body	`string`	Yes	None
`memberships[].entity_revision`	body	`integer`	Yes	None
`memberships[].planning_snapshot`	body	`ScenarioPlanningSnapshot-Output`	Yes	None
`memberships[].introduced_at_tick`	body	`integer`	Yes	None
`memberships[].associated_with_id`	body	`string \| null`	No	None
`memberships[].initial_state_overrides`	body	`ScenarioInitialStateOverrides-Output`	No	None
`memberships[].out_of_date`	body	`boolean`	Yes	None
`memberships[].removed_from_operation`	body	`boolean`	Yes	None
`input_hash`	body	`string`	Yes	None
`created_at`	body	`string`	Yes	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/scenarios/v2" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "untitled",
  "starts_at": "2026-06-01T00:00:00Z",
  "snapshot_duration_hours": 24
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/scenarios/v2",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "name": "untitled",
        "starts_at": "2026-06-01T00:00:00Z",
        "snapshot_duration_hours": 24
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "schema_version": 0,
  "revision": 0,
  "starts_at": "2026-06-01T00:00:00Z",
  "snapshot_duration_hours": 0,
  "plan": {
    "schema_version": 2,
    "capability_resolver_version": "2",
    "ticks": [
      {
        "order": {},
        "entity_changes": {},
        "engagements": {}
      }
    ]
  }
}

Soil1 operations

GET/api/soil/unitsSoilrouter.Get Soil Unit

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string`	Yes	None
`mukey`	query	`integer`	Yes	None
`lon`	query	`number`	Yes	None
`lat`	query	`number`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/soil/units?map_id=<map_id>&mukey=<mukey>&lon=<lon>&lat=<lat>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/soil/units",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

Terrain Analysis15 operations

POST/api/terrain-analysis/Terrainanalysisrouter.Terrain Analysis

Parameters

Name	In	Type	Required	Description
`boundary_shape`	body	`object`	Yes	None
`map_id`	body	`string`	Yes	None
`include_population`	body	`boolean`	No	None
`include_buildings`	body	`boolean`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "boundary_shape": {},
  "map_id": "00000000-0000-0000-0000-000000000000",
  "include_population": false,
  "include_buildings": false
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "boundary_shape": {},
        "map_id": "00000000-0000-0000-0000-000000000000",
        "include_population": false,
        "include_buildings": false
    },
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

GET/api/terrain-analysis/chat/maps/{map_id}/sessionsTerrainanalysisrouter.List Conversation Sessions

Parameters

Name	In	Type	Required	Description
`map_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`array<TerrainAnalysisSessionResponse>`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonarray<TerrainAnalysisSessionResponse>

Name	In	Type	Required	Description
`body`	body	`array<TerrainAnalysisSessionResponse>`	Yes	None
`body[].id`	body	`string`	Yes	None
`body[].user_id`	body	`string`	Yes	None
`body[].map_id`	body	`string`	Yes	None
`body[].is_active`	body	`boolean`	Yes	None
`body[].last_activity`	body	`string`	Yes	None
`body[].created_at`	body	`string`	Yes	None
`body[].updated_at`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/chat/maps/<map_id>/sessions" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/chat/maps/<map_id>/sessions",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "map_id": "00000000-0000-0000-0000-000000000000",
    "is_active": true,
    "last_activity": "2026-06-01T00:00:00Z",
    "created_at": "2026-06-01T00:00:00Z",
    "updated_at": "2026-06-01T00:00:00Z"
  }
]

POST/api/terrain-analysis/chat/sessions/{session_id}/activateTerrainanalysisrouter.Activate Session

Parameters

Name	In	Type	Required	Description
`session_id`	path	`string`	Yes	None
`map_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/activate?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/activate",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/terrain-analysis/chat/sessions/{session_id}/conversationTerrainanalysisrouter.Get Conversation By Session Id

Parameters

Name	In	Type	Required	Description
`session_id`	path	`string`	Yes	None
`map_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`array<TerrainAgentChatMessage>`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonarray<TerrainAgentChatMessage>

Name	In	Type	Required	Description
`body`	body	`array<TerrainAgentChatMessage>`	Yes	None
`body[].id`	body	`string`	Yes	None
`body[].index`	body	`integer`	Yes	None
`body[].role`	body	`string`	Yes	None
`body[].event_type`	body	`string \| null`	No	None
`body[].content`	body	`string \| null`	No	None
`body[].tool_name`	body	`string \| null`	No	None
`body[].tool_args`	body	`string \| null`	No	None
`body[].tool_result`	body	`string \| null`	No	None
`body[].created_at`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/conversation?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/conversation",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "index": 0,
    "role": "string",
    "event_type": "string",
    "content": "string",
    "tool_name": "string",
    "tool_args": "string",
    "tool_result": "string"
  }
]

POST/api/terrain-analysis/chat/sessions/{session_id}/conversation/clearTerrainanalysisrouter.Clear Session Messages

Parameters

Name	In	Type	Required	Description
`session_id`	path	`string`	Yes	None
`map_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/conversation/clear?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/chat/sessions/<session_id>/conversation/clear",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/terrain-analysis/chat/streamTerrainanalysisrouter.Chat Stream

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`scenario_id`	body	`string`	Yes	None
`snapshot_order`	body	`integer`	Yes	None
`prompt`	body	`string`	Yes	None
`flow_id`	body	`string \| null`	No	None
`viewport_bbox_wgs84`	body	`array<number> \| null`	No	Current map viewport as [west, south, east, north] in WGS84 degrees.
`map_zoom`	body	`number \| null`	No	None
`cursor_latitude`	body	`number \| null`	No	None
`cursor_longitude`	body	`number \| null`	No	None
`mobility_config`	body	`PathfindingMobilityConfig \| null`	No	None
`confirmation_response`	body	`TerrainAnalysisConfirmationResponse \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/chat/stream" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "string",
  "scenario_id": "string",
  "snapshot_order": 0,
  "prompt": "string",
  "flow_id": "string",
  "viewport_bbox_wgs84": [
    0
  ],
  "map_zoom": 0,
  "cursor_latitude": 0
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/chat/stream",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "string",
        "scenario_id": "string",
        "snapshot_order": 0,
        "prompt": "string",
        "flow_id": "string",
        "viewport_bbox_wgs84": [
            0
        ],
        "map_zoom": 0,
        "cursor_latitude": 0
    },
)
print(response.json())

Example response

{}

GET/api/terrain-analysis/jobs/{job_id}Terrainanalysisrouter.Get Terrain Analysis Job

Parameters

Name	In	Type	Required	Description
`job_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/jobs/<job_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/jobs/<job_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

POST/api/terrain-analysis/jobs/{job_id}/cancelTerrainanalysisrouter.Cancel Terrain Analysis Job

Parameters

Name	In	Type	Required	Description
`job_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/jobs/<job_id>/cancel" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/jobs/<job_id>/cancel",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

GET/api/terrain-analysis/jobs/latestTerrainanalysisrouter.Latest Terrain Analysis Job

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse \| null`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse | null

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/jobs/latest?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/jobs/latest",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

POST/api/terrain-analysis/rf-propagationTerrainanalysisrouter.Rf Propagation

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`boundary_shape`	body	`object \| null`	No	None
`receiver_height_m`	body	`number`	No	None
`resolution_m`	body	`number`	No	None
`max_radius_m`	body	`number \| null`	No	None
`layer_name`	body	`string \| null`	No	None
`environment`	body	`RfEnvironmentRequest`	No	None
`quality_preset`	body	`exact \| high \| balanced \| fast \| preview`	No	None
`model_mode`	body	`exact \| hybrid \| polar \| null`	No	None
`angular_step_deg`	body	`number \| null`	No	None
`radial_step_m`	body	`number \| null`	No	None
`terrain_sample_scale`	body	`integer \| null`	No	None
`max_path_samples`	body	`integer \| null`	No	None
`near_field_exact_radius_m`	body	`number \| null`	No	None
`shadow_boundary_refinement_m`	body	`number \| null`	No	None
`transmitters`	body	`array<RfTransmitterRequest>`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "boundary_shape": {},
  "receiver_height_m": 2,
  "resolution_m": 30,
  "max_radius_m": 0,
  "layer_name": "RF Propagation",
  "environment": {
    "dielectric_constant": 15,
    "conductivity_s_per_m": 0.005,
    "surface_refractivity_n_units": 301,
    "radio_climate": 5,
    "polarization": "horizontal",
    "confidence": 0.5,
    "reliability": 0.5
  },
  "quality_preset": "balanced"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "boundary_shape": {},
        "receiver_height_m": 2,
        "resolution_m": 30,
        "max_radius_m": 0,
        "layer_name": "RF Propagation",
        "environment": {
            "dielectric_constant": 15,
            "conductivity_s_per_m": 0.005,
            "surface_refractivity_n_units": 301,
            "radio_climate": 5,
            "polarization": "horizontal",
            "confidence": 0.5,
            "reliability": 0.5
        },
        "quality_preset": "balanced"
    },
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

GET/api/terrain-analysis/rf-propagation/catalogGet the RF equipment catalog

Returns the server-owned radio, antenna, and mast defaults used to complete communications.radio entity capabilities. API keys require the ENTITIES scope.

Parameters

This endpoint does not declare parameters or a request body.

Responses

Name	In	Type	Required	Description
`200`	application/json	`RfCatalogResponse`	No	Successful Response
`403`	response	`unknown`	No	The API key lacks the ENTITIES scope.

Response body

200application/jsonRfCatalogResponse

Name	In	Type	Required	Description
`schema_version`	body	`integer`	No	None
`radios`	body	`object`	Yes	Known radio models keyed by the model identifier accepted by communications.radio.
`radios.{key}`	body	`RadioCatalogDefinition`	No	None
`radios.{key}.full_name`	body	`string`	Yes	None
`radios.{key}.family`	body	`string \| null`	No	None
`radios.{key}.nomenclatures`	body	`array<string>`	Yes	None
`radios.{key}.frequency_bands`	body	`array<array<unknown>>`	Yes	None
`radios.{key}.power_levels`	body	`array<RadioCatalogPowerLevel>`	Yes	None
`radios.{key}.requires_antenna`	body	`boolean`	No	None
`radios.{key}.notes`	body	`string \| null`	No	None
`antennas`	body	`object`	Yes	Known antenna models keyed by model identifier.
`antennas.{key}`	body	`AntennaCatalogDefinition`	No	None
`antennas.{key}.full_name`	body	`string`	Yes	None
`antennas.{key}.frequency_band_mhz`	body	`array<unknown>`	Yes	None
`antennas.{key}.default_height_ft`	body	`number`	Yes	None
`antennas.{key}.mast_supported`	body	`boolean`	Yes	None
`antennas.{key}.notes`	body	`string \| null`	No	None
`masts`	body	`object`	Yes	Known antenna mast models keyed by model identifier.
`masts.{key}`	body	`MastCatalogDefinition`	No	None
`masts.{key}.full_name`	body	`string`	Yes	None
`masts.{key}.height_ft`	body	`number`	Yes	None
`masts.{key}.notes`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/catalog" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/catalog",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "schema_version": 1,
  "radios": {},
  "antennas": {},
  "masts": {}
}

POST/api/terrain-analysis/rf-propagation/entitiesRun RF propagation from operation entities

Resolves located communications.radio capabilities from entities in the map's operation, queues the same RF job used by the explicit-transmitter endpoint, and reports skipped inputs as warnings. API keys require the ENTITIES scope.

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`boundary_shape`	body	`object \| null`	No	None
`receiver_height_m`	body	`number`	No	None
`resolution_m`	body	`number`	No	None
`max_radius_m`	body	`number \| null`	No	None
`layer_name`	body	`string \| null`	No	None
`environment`	body	`RfEnvironmentRequest`	No	None
`quality_preset`	body	`exact \| high \| balanced \| fast \| preview`	No	None
`model_mode`	body	`exact \| hybrid \| polar \| null`	No	None
`angular_step_deg`	body	`number \| null`	No	None
`radial_step_m`	body	`number \| null`	No	None
`terrain_sample_scale`	body	`integer \| null`	No	None
`max_path_samples`	body	`integer \| null`	No	None
`near_field_exact_radius_m`	body	`number \| null`	No	None
`shadow_boundary_refinement_m`	body	`number \| null`	No	None
`entities`	body	`array<RfEntitySelectionRequest>`	Yes	Operation entities whose configured communications.radio capabilities should transmit.

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`403`	response	`unknown`	No	Operation access was denied or the API key lacks the ENTITIES scope.
`422`	response	`unknown`	No	No usable transmitter remains, more than 32 resolve, or the request is invalid.

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/entities" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "boundary_shape": {},
  "receiver_height_m": 2,
  "resolution_m": 30,
  "max_radius_m": 0,
  "layer_name": "RF Propagation",
  "environment": {
    "dielectric_constant": 15,
    "conductivity_s_per_m": 0.005,
    "surface_refractivity_n_units": 301,
    "radio_climate": 5,
    "polarization": "horizontal",
    "confidence": 0.5,
    "reliability": 0.5
  },
  "quality_preset": "balanced"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/entities",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "boundary_shape": {},
        "receiver_height_m": 2,
        "resolution_m": 30,
        "max_radius_m": 0,
        "layer_name": "RF Propagation",
        "environment": {
            "dielectric_constant": 15,
            "conductivity_s_per_m": 0.005,
            "surface_refractivity_n_units": 301,
            "radio_climate": 5,
            "polarization": "horizontal",
            "confidence": 0.5,
            "reliability": 0.5
        },
        "quality_preset": "balanced"
    },
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

GET/api/terrain-analysis/rf-propagation/jobs/{job_id}Terrainanalysisrouter.Get Rf Propagation Job

Parameters

Name	In	Type	Required	Description
`job_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/<job_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/<job_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

POST/api/terrain-analysis/rf-propagation/jobs/{job_id}/cancelTerrainanalysisrouter.Cancel Rf Propagation Job

Parameters

Name	In	Type	Required	Description
`job_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/<job_id>/cancel" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/<job_id>/cancel",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

GET/api/terrain-analysis/rf-propagation/jobs/latestTerrainanalysisrouter.Latest Rf Propagation Job

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`TerrainAnalysisResponse \| null`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonTerrainAnalysisResponse | null

Name	In	Type	Required	Description
`errors`	body	`array<string>`	Yes	None
`warnings`	body	`array<string>`	No	None
`sources`	body	`object`	No	None
`sources.{key}`	body	`DataSourceStatus`	No	None
`sources.{key}.ok`	body	`boolean`	Yes	None
`sources.{key}.message`	body	`string \| null`	No	None
`sources.{key}.code`	body	`string \| null`	No	None
`job_id`	body	`string \| null`	No	None
`status`	body	`string \| null`	No	None
`analysis_ready`	body	`boolean`	No	None
`display_ready`	body	`boolean`	No	None
`can_cancel`	body	`boolean`	No	None
`overall`	body	`object \| null`	No	None
`phases`	body	`array<object>`	No	None
`source_versions`	body	`object \| null`	No	None
`source_versions.{key}`	body	`string`	No	None
`degraded_sources`	body	`array<string> \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/latest?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/terrain-analysis/rf-propagation/jobs/latest",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false
}

Units7 operations

POST/api/units/Unitrouter.Create Unit

Parameters

Name	In	Type	Required	Description
`icon`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	No	None
`name`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`UnitResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonUnitResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	Yes	None
`name`	body	`string`	Yes	None
`icon`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`policies`	body	`array<string>`	Yes	None
`notification`	body	`string \| null`	Yes	None
`num_operations`	body	`integer`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://service-blue.exialabs.com/api/units/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "icon": "string",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "branch": "string",
  "echelon": "string"
}'

Python

import requests

response = requests.post(
    "https://service-blue.exialabs.com/api/units/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "icon": "string",
        "parent_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "branch": "string",
        "echelon": "string"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "icon": "string",
  "branch": "string",
  "echelon": "string",
  "policies": [
    "string"
  ]
}

GET/api/units/Unitrouter.Get Units

Parameters

Name	In	Type	Required	Description
`parent_id`	query	`string \| null`	No	None
`query`	query	`string \| null`	No	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListUnitResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListUnitResponse

Name	In	Type	Required	Description
`units`	body	`array<UnitResponse>`	Yes	None
`units[].id`	body	`string`	Yes	None
`units[].user_id`	body	`string`	Yes	None
`units[].parent_id`	body	`string \| null`	Yes	None
`units[].name`	body	`string`	Yes	None
`units[].icon`	body	`string`	Yes	None
`units[].branch`	body	`string`	Yes	None
`units[].echelon`	body	`string`	Yes	None
`units[].policies`	body	`array<string>`	Yes	None
`units[].notification`	body	`string \| null`	Yes	None
`units[].num_operations`	body	`integer`	Yes	None
`units[].created_at`	body	`string \| null`	No	None
`units[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/units/?parent_id=<parent_id>&query=<query>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/units/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "units": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "parent_id": {},
      "name": "string",
      "icon": "string",
      "branch": "string",
      "echelon": "string",
      "policies": [
        {}
      ]
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/units/{unit_id}Unitrouter.Update Unit

Parameters

Name	In	Type	Required	Description
`unit_id`	path	`string`	Yes	None
`icon`	body	`string \| null`	No	None
`parent_id`	body	`string \| null`	No	None
`name`	body	`string \| null`	No	None
`branch`	body	`string \| null`	No	None
`echelon`	body	`string \| null`	No	None
`notification`	body	`string \| null`	No	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X PUT "https://service-blue.exialabs.com/api/units/<unit_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "icon": "string",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "branch": "string",
  "echelon": "string",
  "notification": "string"
}'

Python

import requests

response = requests.put(
    "https://service-blue.exialabs.com/api/units/<unit_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "icon": "string",
        "parent_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "branch": "string",
        "echelon": "string",
        "notification": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/units/{unit_id}Unitrouter.Get Unit

Parameters

Name	In	Type	Required	Description
`unit_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`UnitResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonUnitResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	Yes	None
`name`	body	`string`	Yes	None
`icon`	body	`string`	Yes	None
`branch`	body	`string`	Yes	None
`echelon`	body	`string`	Yes	None
`policies`	body	`array<string>`	Yes	None
`notification`	body	`string \| null`	Yes	None
`num_operations`	body	`integer`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/units/<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/units/<unit_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "icon": "string",
  "branch": "string",
  "echelon": "string",
  "policies": [
    "string"
  ]
}

DELETE/api/units/{unit_id}Unitrouter.Delete Unit

Parameters

Name	In	Type	Required	Description
`unit_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`MessageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonMessageResponse

Name	In	Type	Required	Description
`message`	body	`string`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://service-blue.exialabs.com/api/units/<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://service-blue.exialabs.com/api/units/<unit_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/units/{unit_id}/iconUnitrouter.Get Icon

Parameters

Name	In	Type	Required	Description
`unit_id`	path	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`object`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonobject

Name	In	Type	Required	Description
`body`	body	`object`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/units/<unit_id>/icon" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/units/<unit_id>/icon",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/units/parentsUnitrouter.Get Parent Units

Parameters

Name	In	Type	Required	Description
`unit_id`	query	`string`	Yes	None

Responses

Name	In	Type	Required	Description
`200`	application/json	`ListUnitResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListUnitResponse

Name	In	Type	Required	Description
`units`	body	`array<UnitResponse>`	Yes	None
`units[].id`	body	`string`	Yes	None
`units[].user_id`	body	`string`	Yes	None
`units[].parent_id`	body	`string \| null`	Yes	None
`units[].name`	body	`string`	Yes	None
`units[].icon`	body	`string`	Yes	None
`units[].branch`	body	`string`	Yes	None
`units[].echelon`	body	`string`	Yes	None
`units[].policies`	body	`array<string>`	Yes	None
`units[].notification`	body	`string \| null`	Yes	None
`units[].num_operations`	body	`integer`	Yes	None
`units[].created_at`	body	`string \| null`	No	None
`units[].updated_at`	body	`string \| null`	No	None
`pagination`	body	`PaginationResponse`	Yes	None
`pagination.current_page`	body	`integer \| null`	No	None
`pagination.total_pages`	body	`integer \| null`	No	None
`pagination.total_records`	body	`integer \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://service-blue.exialabs.com/api/units/parents?unit_id=<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://service-blue.exialabs.com/api/units/parents",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "units": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "parent_id": {},
      "name": "string",
      "icon": "string",
      "branch": "string",
      "echelon": "string",
      "policies": [
        {}
      ]
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

REST API

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Parameters

Responses

Response body

Parameters

Request variants

boundary example

named_area_interest example

annotation example

geojson example

position_area_artillery example

logistic_release_point example

Responses

Response headers

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response body

Parameters

Responses

Response headers

`boundary` example

`named_area_interest` example

`annotation` example

`geojson` example

`position_area_artillery` example

`logistic_release_point` example