Blue API Reference

API Docs

REST reference for the Blue API.

121REST paths

195Schemas

170Operations

2Guide pages

REST API

Updated 6/2/2026, 3:05:52 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://api.example.com/api/api-keys/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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
`prefix`	body	`string \| null`	No	None
`name`	body	`string \| null`	No	None
`scopes`	body	`array<AuthScope>`	Yes	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://api.example.com/api/api-keys/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "prefix": "sk-",
  "name": "New API Key",
  "scopes": [
    "ARGUS"
  ],
  "device_id": "string",
  "time_to_live_seconds": 0
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/api-keys/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "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://api.example.com/api/api-keys/<api_key_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/auth/callback?code=<code>&state=<state>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/auth/login" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/auth/logout" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{}

COA Comparison2 operations

POST/api/comparisons/Comparisonrouter.Generate Comparison

Parameters

Name	In	Type	Required	Description
`coa_statement_ids`	body	`array<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://api.example.com/api/comparisons/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "coa_statement_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/comparisons/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "coa_statement_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/comparisons/Comparisonrouter.Get Comparison

Parameters

Name	In	Type	Required	Description
`coa_statement_ids`	query	`array<string>`	Yes	None

Responses

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

Response body

200application/jsonComparisonResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`comparison`	body	`array<Comparison> \| null`	Yes	None
`comparison[].id`	body	`string`	Yes	None
`comparison[].coa_name`	body	`string`	Yes	None
`comparison[].advantages`	body	`string`	Yes	None
`comparison[].disadvantages`	body	`string`	Yes	None
`comparison[].risks`	body	`string`	Yes	None
`guidelines`	body	`string \| null`	Yes	None
`status`	body	`WorkerStatus`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/comparisons/?coa_statement_ids=<coa_statement_ids>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "comparison": [
    {
      "id": {},
      "coa_name": {},
      "advantages": {},
      "disadvantages": {},
      "risks": {}
    }
  ],
  "guidelines": "string",
  "status": "processing",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

COA Statements16 operations

POST/api/coa-statements/Coastatementrouter.Create Coa Statement

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`name`	body	`string`	Yes	None
`sections`	body	`array<COAStatementAvailable>`	Yes	None

Responses

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

Response body

200application/jsonCOAStatementResponse

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

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/coa-statements/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "sections": [
    "Mission"
  ]
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/coa-statements/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "sections": [
            "Mission"
        ]
    },
)
print(response.json())

Example response

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

GET/api/coa-statements/Coastatementrouter.Get Coa Statements

Parameters

Name	In	Type	Required	Description
`operation_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	`ListCOAStatementResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListCOAStatementResponse

Name	In	Type	Required	Description
`coa_statements`	body	`array<COAStatementResponse>`	Yes	None
`coa_statements[].id`	body	`string`	Yes	None
`coa_statements[].user_id`	body	`string`	Yes	None
`coa_statements[].operation_id`	body	`string`	Yes	None
`coa_statements[].name`	body	`string \| null`	Yes	None
`coa_statements[].temperature`	body	`number`	Yes	None
`coa_statements[].created_at`	body	`string \| null`	No	None
`coa_statements[].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://api.example.com/api/coa-statements/?operation_id=<operation_id>&query=<query>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "coa_statements": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "name": {},
      "temperature": 0,
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/coa-statements/{coa_statement_id}Coastatementrouter.Update Coa Statement

Parameters

Name	In	Type	Required	Description
`coa_statement_id`	path	`string`	Yes	None
`name`	body	`string \| null`	No	None
`sections`	body	`array<COAStatementAvailable> \| 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://api.example.com/api/coa-statements/<coa_statement_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "sections": [
    "Mission"
  ]
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/coa-statements/<coa_statement_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string",
        "sections": [
            "Mission"
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/coa-statements/{coa_statement_id}Coastatementrouter.Get Coa Statement

Parameters

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

Responses

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

Response body

200application/jsonCOAStatementResponse

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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/coa-statements/<coa_statement_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/<coa_statement_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

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

DELETE/api/coa-statements/{coa_statement_id}Coastatementrouter.Delete Coa Statement

Parameters

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

Responses

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

Response body

200application/jsonCOAStatementResponse

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

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/coa-statements/<coa_statement_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/coa-statements/<coa_statement_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

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

PUT/api/coa-statements/{coa_statement_id}/{attribute_id}Coastatementattributerouter.Update Coa Statement Attribute

Parameters

Name	In	Type	Required	Description
`coa_statement_id`	path	`string`	Yes	None
`attribute_id`	path	`string`	Yes	None
`content`	body	`string \| null`	No	None
`generated_output`	body	`string \| null`	No	None
`guidelines`	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://api.example.com/api/coa-statements/<coa_statement_id>/<attribute_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "generated_output": "string",
  "guidelines": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/coa-statements/<coa_statement_id>/<attribute_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "content": "string",
        "generated_output": "string",
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/coa-statements/{coa_statement_id}/{attribute_id}Coastatementattributerouter.Get Coa Statement Attribute

Parameters

Name	In	Type	Required	Description
`coa_statement_id`	path	`string`	Yes	None
`attribute_id`	path	`string`	Yes	None

Responses

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

Response body

200application/jsonCOAStatementAttributeResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`content`	body	`string \| null`	Yes	None
`generated_output`	body	`string \| null`	Yes	None
`guidelines`	body	`string \| null`	Yes	None
`type`	body	`COAStatementAvailable`	Yes	None
`name`	body	`string \| null`	Yes	None
`section_order`	body	`integer \| null`	Yes	None
`status`	body	`WorkerStatus \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/coa-statements/<coa_statement_id>/<attribute_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/<coa_statement_id>/<attribute_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "generated_output": "string",
  "guidelines": "string",
  "type": "Mission"
}

GET/api/coa-statements/{coa_statement_id}/attributesCoastatementattributerouter.Get Coa Statement Attributes

Parameters

Name	In	Type	Required	Description
`coa_statement_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	`array<COAStatementAttributeResponse>`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonarray<COAStatementAttributeResponse>

Name	In	Type	Required	Description
`body`	body	`array<COAStatementAttributeResponse>`	Yes	None
`body[].id`	body	`string`	Yes	None
`body[].user_id`	body	`string`	Yes	None
`body[].operation_id`	body	`string`	Yes	None
`body[].coa_statement_id`	body	`string`	Yes	None
`body[].content`	body	`string \| null`	Yes	None
`body[].generated_output`	body	`string \| null`	Yes	None
`body[].guidelines`	body	`string \| null`	Yes	None
`body[].type`	body	`COAStatementAvailable`	Yes	None
`body[].name`	body	`string \| null`	Yes	None
`body[].section_order`	body	`integer \| null`	Yes	None
`body[].status`	body	`WorkerStatus \| null`	No	None
`body[].created_at`	body	`string \| null`	No	None
`body[].updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/coa-statements/<coa_statement_id>/attributes?size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/<coa_statement_id>/attributes",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "operation_id": "00000000-0000-0000-0000-000000000000",
    "coa_statement_id": "00000000-0000-0000-0000-000000000000",
    "content": "string",
    "generated_output": "string",
    "guidelines": "string",
    "type": "Mission"
  }
]

POST/api/coa-statements/attribute/{attribute_id}/generateCoastatementattributerouter.Generate Single Warno

Parameters

Name	In	Type	Required	Description
`attribute_id`	path	`string`	Yes	None
`guidelines`	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://api.example.com/api/coa-statements/attribute/<attribute_id>/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/coa-statements/attribute/<attribute_id>/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/coa-statements/fieldsCoastatementrouter.Get Available Fields

Parameters

This endpoint does not declare parameters or a request body.

Responses

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

Response body

200application/jsonarray<COAStatementAvailable>

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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/coa-statements/fields" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/fields",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  "Mission"
]

POST/api/coa-statements/generateCoastatementrouter.Generate Coa Statement

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`number_of_coas`	body	`integer`	Yes	None
`temperature`	body	`number`	No	None
`guidelines`	body	`string \| null`	No	None

Responses

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

Response body

200application/jsonListCOAStatementResponse

Name	In	Type	Required	Description
`coa_statements`	body	`array<COAStatementResponse>`	Yes	None
`coa_statements[].id`	body	`string`	Yes	None
`coa_statements[].user_id`	body	`string`	Yes	None
`coa_statements[].operation_id`	body	`string`	Yes	None
`coa_statements[].name`	body	`string \| null`	Yes	None
`coa_statements[].temperature`	body	`number`	Yes	None
`coa_statements[].created_at`	body	`string \| null`	No	None
`coa_statements[].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 POST "https://api.example.com/api/coa-statements/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "number_of_coas": 0,
  "temperature": 0,
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/coa-statements/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "number_of_coas": 0,
        "temperature": 0,
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "coa_statements": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "name": {},
      "temperature": 0,
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/coa-statements/sections/Coastatementsectionrouter.Create Coa Statement Section

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`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 POST "https://api.example.com/api/coa-statements/sections/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "name": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/coa-statements/sections/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "coa_statement_id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/coa-statements/sections/Coastatementsectionrouter.Get Coa Statement Sections

Parameters

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

Responses

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

Response body

200application/jsonListCOAStatementSectionResponse

Name	In	Type	Required	Description
`coa_statement_sections`	body	`array<COAStatementSectionResponse>`	Yes	None
`coa_statement_sections[].id`	body	`string`	Yes	None
`coa_statement_sections[].operation_id`	body	`string`	Yes	None
`coa_statement_sections[].coa_statement_id`	body	`string`	Yes	None
`coa_statement_sections[].name`	body	`string`	Yes	None
`coa_statement_sections[].section_order`	body	`integer`	Yes	None
`coa_statement_sections[].type`	body	`COAStatementSectionType`	Yes	None
`coa_statement_sections[].created_at`	body	`string \| null`	No	None
`coa_statement_sections[].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://api.example.com/api/coa-statements/sections/?coa_statement_id=<coa_statement_id>&is_get_all_system_fields=<is_get_all_system_fields>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/coa-statements/sections/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "coa_statement_sections": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "section_order": 0,
      "type": "system",
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/coa-statements/sections/Coastatementsectionrouter.Arrange Coa Statement Section

Parameters

Name	In	Type	Required	Description
`coa_statement_id`	body	`string`	Yes	None
`sections`	body	`array<COAStatementSection>`	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://api.example.com/api/coa-statements/sections/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "sections": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "section_order": 0
    }
  ]
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/coa-statements/sections/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "coa_statement_id": "00000000-0000-0000-0000-000000000000",
        "sections": [
            {
                "id": "00000000-0000-0000-0000-000000000000",
                "section_order": 0
            }
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

PUT/api/coa-statements/sections/{coa_statement_section_id}Coastatementsectionrouter.Update Coa Statement Section

Parameters

Name	In	Type	Required	Description
`coa_statement_section_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://api.example.com/api/coa-statements/sections/<coa_statement_section_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/coa-statements/sections/<coa_statement_section_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "name": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

DELETE/api/coa-statements/sections/{coa_statement_section_id}Coastatementsectionrouter.Delete Coa Statement Section

Parameters

Name	In	Type	Required	Description
`coa_statement_section_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://api.example.com/api/coa-statements/sections/<coa_statement_section_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/coa-statements/sections/<coa_statement_section_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

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	`WorkerStatus \| 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://api.example.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://api.example.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	`WorkerStatus \| 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://api.example.com/api/documents/?operation_id=<operation_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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	`WorkerStatus \| 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://api.example.com/api/documents/<document_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/documents/<document_id>/presigned-url" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

"string"

Entities8 operations

GET/api/entities/Terrainanalysisrouter.Get Entities

Parameters

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

Responses

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

Response body

200application/jsonEntities

Name	In	Type	Required	Description
`entities`	body	`array<Entity>`	Yes	None
`entities[].id`	body	`string`	Yes	None
`entities[].json_data`	body	`object`	Yes	None
`entities[].sidc`	body	`string`	Yes	None
`entities[].unit_name`	body	`string`	Yes	None
`entities[].update_version`	body	`integer`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/entities/?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "entities": [
    {
      "id": "string",
      "json_data": {},
      "sidc": "string",
      "unit_name": "string",
      "update_version": 0
    }
  ]
}

POST/api/entities/Terrainanalysisrouter.Create Entities

Parameters

Name	In	Type	Required	Description
`entities`	body	`array<CreateEntity>`	Yes	None
`map_id`	body	`string`	Yes	None

Responses

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

Response body

200application/jsonEntities

Name	In	Type	Required	Description
`entities`	body	`array<Entity>`	Yes	None
`entities[].id`	body	`string`	Yes	None
`entities[].json_data`	body	`object`	Yes	None
`entities[].sidc`	body	`string`	Yes	None
`entities[].unit_name`	body	`string`	Yes	None
`entities[].update_version`	body	`integer`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/entities/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entities": [
    {
      "json_data": {},
      "sidc": "string",
      "unit_name": "string"
    }
  ],
  "map_id": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/entities/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "entities": [
            {
                "json_data": {},
                "sidc": "string",
                "unit_name": "string"
            }
        ],
        "map_id": "string"
    },
)
print(response.json())

Example response

{
  "entities": [
    {
      "id": "string",
      "json_data": {},
      "sidc": "string",
      "unit_name": "string",
      "update_version": 0
    }
  ]
}

PUT/api/entities/Terrainanalysisrouter.Update Entities

Parameters

Name	In	Type	Required	Description
`entities`	body	`array<UpdateEntity>`	Yes	None
`map_id`	body	`string`	Yes	None

Responses

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

Response body

200application/jsonUpdateEntitesAPIResponses

Name	In	Type	Required	Description
`entities`	body	`array<UpdateEntityAPIResponse>`	Yes	None
`entities[].applied`	body	`boolean`	Yes	None
`entities[].found`	body	`boolean`	Yes	None
`entities[].entity`	body	`Entity`	Yes	None

Language

ShellPython

Shell

curl -X PUT "https://api.example.com/api/entities/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entities": [
    {
      "id": "string",
      "json_data": {},
      "current_version": 0
    }
  ],
  "map_id": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/entities/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "entities": [
            {
                "id": "string",
                "json_data": {},
                "current_version": 0
            }
        ],
        "map_id": "string"
    },
)
print(response.json())

Example response

{
  "entities": [
    {
      "applied": true,
      "found": true,
      "entity": {
        "id": {},
        "json_data": {},
        "sidc": {},
        "unit_name": {},
        "update_version": {}
      }
    }
  ]
}

DELETE/api/entities/Terrainanalysisrouter.Delete Entities

Parameters

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

Responses

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

Response body

200application/jsonboolean

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

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/entities/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_ids": [
    "string"
  ]
}'

Python

import requests

response = requests.delete(
    "https://api.example.com/api/entities/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "entity_ids": [
            "string"
        ]
    },
)
print(response.json())

Example response

true

GET/api/entities/stagedTerrainanalysisrouter.Get Staged Entities

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string`	Yes	None
`status`	query	`string`	Yes	None

Responses

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

Response body

200application/jsonStagedEntities

Name	In	Type	Required	Description
`entities`	body	`array<StagedEntity>`	Yes	None
`entities[].id`	body	`string`	Yes	None
`entities[].unit_name`	body	`string`	Yes	None
`entities[].sidc`	body	`string`	Yes	None
`entities[].status`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/entities/staged?map_id=<map_id>&status=<status>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/entities/staged",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "entities": [
    {
      "id": "string",
      "unit_name": "string",
      "sidc": "string",
      "status": "string"
    }
  ]
}

POST/api/entities/stagedTerrainanalysisrouter.Create Staged Entities

Parameters

Name	In	Type	Required	Description
`entities`	body	`array<CreateStagedEntity>`	Yes	None
`map_id`	body	`string`	Yes	None

Responses

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

Response body

200application/jsonStagedEntities

Name	In	Type	Required	Description
`entities`	body	`array<StagedEntity>`	Yes	None
`entities[].id`	body	`string`	Yes	None
`entities[].unit_name`	body	`string`	Yes	None
`entities[].sidc`	body	`string`	Yes	None
`entities[].status`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/entities/staged" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entities": [
    {
      "unit_name": "string",
      "sidc": "string",
      "status": "string"
    }
  ],
  "map_id": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/entities/staged",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "entities": [
            {
                "unit_name": "string",
                "sidc": "string",
                "status": "string"
            }
        ],
        "map_id": "string"
    },
)
print(response.json())

Example response

{
  "entities": [
    {
      "id": "string",
      "unit_name": "string",
      "sidc": "string",
      "status": "string"
    }
  ]
}

DELETE/api/entities/stagedTerrainanalysisrouter.Delete Staged Entities

Parameters

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

Responses

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

Response body

200application/jsonboolean

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

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/entities/staged" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_ids": [
    "string"
  ]
}'

Python

import requests

response = requests.delete(
    "https://api.example.com/api/entities/staged",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "entity_ids": [
            "string"
        ]
    },
)
print(response.json())

Example response

true

POST/api/entities/staged/generateTerrainanalysisrouter.Generate Staged Entities

Parameters

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

Responses

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

Response body

200application/jsonEntitiesGenerateResponse

Name	In	Type	Required	Description
`documents_found`	body	`boolean`	Yes	None
`red_units`	body	`array<RedUnit>`	Yes	None
`red_units[].unit_name`	body	`string`	Yes	None
`red_units[].odin_results`	body	`object`	Yes	None
`blue_units`	body	`array<BlueUnit>`	Yes	None
`blue_units[].unit_name`	body	`string`	Yes	None
`blue_units[].sidc`	body	`string`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/entities/staged/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "string",
  "map_id": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/entities/staged/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "string",
        "map_id": "string"
    },
)
print(response.json())

Example response

{
  "documents_found": true,
  "red_units": [
    {
      "unit_name": "string",
      "odin_results": {}
    }
  ],
  "blue_units": [
    {
      "unit_name": "string",
      "sidc": "string"
    }
  ]
}

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://api.example.com/api/entity-resolution/entities/<entity_id>/history" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/entity-resolution/entities/<entity_id>/observations" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/entity-resolution/entities/clear" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/entity-resolution/entities/current" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{}

Evaluation Criteria13 operations

GET/api/evaluation-criteria/Evaluationcriteriarouter.Get Evaluation Criteria

Parameters

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

Responses

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

Response body

200application/jsonEvaluationCriteriaResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`extra_information`	body	`string \| null`	Yes	None
`formula_grading`	body	`FormulaGrading`	Yes	None
`status`	body	`WorkerStatus \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/evaluation-criteria/?operation_id=<operation_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "extra_information": "string",
  "formula_grading": "Lower is better",
  "status": "processing",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

PUT/api/evaluation-criteria/{evaluation_criteria_id}Evaluationcriteriarouter.Update Evaluation Criteria

Parameters

Name	In	Type	Required	Description
`evaluation_criteria_id`	path	`string`	Yes	None
`extra_information`	body	`string \| null`	No	None
`formula_grading`	body	`FormulaGrading \| 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://api.example.com/api/evaluation-criteria/<evaluation_criteria_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "extra_information": "string",
  "formula_grading": "Lower is better"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/evaluation-criteria/<evaluation_criteria_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "extra_information": "string",
        "formula_grading": "Lower is better"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/evaluation-criteria/attributes/Evaluationcriteriaattributerouter.Create Evaluation Criteria Attribute

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`evaluation_criteria_id`	body	`string`	Yes	None
`title`	body	`string`	No	None
`definition`	body	`string`	No	None
`unit_of_measure`	body	`string`	No	None
`benchmark`	body	`string`	No	None
`formula_name`	body	`string`	No	None
`formula_function`	body	`CriteriaFormulaFunction`	No	None
`formula_coefficient`	body	`number`	No	None

Responses

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

Response body

200application/jsonEvaluationCriteriaAttributeResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`evaluation_criteria_id`	body	`string`	Yes	None
`title`	body	`string`	Yes	None
`title_type`	body	`AttributeType`	Yes	None
`definition`	body	`string \| null`	Yes	None
`unit_of_measure`	body	`string`	Yes	None
`unit_of_measure_type`	body	`AttributeType`	Yes	None
`benchmark`	body	`string`	Yes	None
`benchmark_type`	body	`AttributeType`	Yes	None
`formula_name`	body	`string`	Yes	None
`formula_type`	body	`AttributeType`	Yes	None
`formula_function`	body	`CriteriaFormulaFunction`	Yes	None
`formula_coefficient`	body	`number`	Yes	None
`attribute_order`	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://api.example.com/api/evaluation-criteria/attributes/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
  "title": "Casualties",
  "definition": "string",
  "unit_of_measure": "Number",
  "benchmark": "More is better",
  "formula_name": "Casualties",
  "formula_function": "+"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/evaluation-criteria/attributes/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
        "title": "Casualties",
        "definition": "string",
        "unit_of_measure": "Number",
        "benchmark": "More is better",
        "formula_name": "Casualties",
        "formula_function": "+"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
  "title": "string",
  "title_type": "custom",
  "definition": "string",
  "unit_of_measure": "string"
}

GET/api/evaluation-criteria/attributes/Evaluationcriteriaattributerouter.Get Evaluation Criteria Attributes

Parameters

Name	In	Type	Required	Description
`evaluation_criteria_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	`ListEvaluationCriteriaAttributeResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListEvaluationCriteriaAttributeResponse

Name	In	Type	Required	Description
`evaluation_criteria_attributes`	body	`array<EvaluationCriteriaAttributeResponse>`	Yes	None
`evaluation_criteria_attributes[].id`	body	`string`	Yes	None
`evaluation_criteria_attributes[].user_id`	body	`string`	Yes	None
`evaluation_criteria_attributes[].operation_id`	body	`string`	Yes	None
`evaluation_criteria_attributes[].evaluation_criteria_id`	body	`string`	Yes	None
`evaluation_criteria_attributes[].title`	body	`string`	Yes	None
`evaluation_criteria_attributes[].title_type`	body	`AttributeType`	Yes	None
`evaluation_criteria_attributes[].definition`	body	`string \| null`	Yes	None
`evaluation_criteria_attributes[].unit_of_measure`	body	`string`	Yes	None
`evaluation_criteria_attributes[].unit_of_measure_type`	body	`AttributeType`	Yes	None
`evaluation_criteria_attributes[].benchmark`	body	`string`	Yes	None
`evaluation_criteria_attributes[].benchmark_type`	body	`AttributeType`	Yes	None
`evaluation_criteria_attributes[].formula_name`	body	`string`	Yes	None
`evaluation_criteria_attributes[].formula_type`	body	`AttributeType`	Yes	None
`evaluation_criteria_attributes[].formula_function`	body	`CriteriaFormulaFunction`	Yes	None
`evaluation_criteria_attributes[].formula_coefficient`	body	`number`	Yes	None
`evaluation_criteria_attributes[].attribute_order`	body	`integer`	Yes	None
`evaluation_criteria_attributes[].created_at`	body	`string \| null`	No	None
`evaluation_criteria_attributes[].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://api.example.com/api/evaluation-criteria/attributes/?evaluation_criteria_id=<evaluation_criteria_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/attributes/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "evaluation_criteria_attributes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "title_type": "custom",
      "definition": {},
      "unit_of_measure": "string"
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/evaluation-criteria/attributes/{evaluation_criteria_attribute_id}Evaluationcriteriaattributerouter.Update Evaluation Criteria Attribute

Parameters

Name	In	Type	Required	Description
`evaluation_criteria_attribute_id`	path	`string`	Yes	None
`title`	body	`string \| null`	No	None
`definition`	body	`string \| null`	No	None
`unit_of_measure`	body	`string \| null`	No	None
`benchmark`	body	`string \| null`	No	None
`formula_name`	body	`string \| null`	No	None
`formula_function`	body	`CriteriaFormulaFunction \| null`	No	None
`formula_coefficient`	body	`number \| 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://api.example.com/api/evaluation-criteria/attributes/<evaluation_criteria_attribute_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "definition": "string",
  "unit_of_measure": "string",
  "benchmark": "string",
  "formula_name": "string",
  "formula_function": "+",
  "formula_coefficient": 0
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/evaluation-criteria/attributes/<evaluation_criteria_attribute_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "title": "string",
        "definition": "string",
        "unit_of_measure": "string",
        "benchmark": "string",
        "formula_name": "string",
        "formula_function": "+",
        "formula_coefficient": 0
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/evaluation-criteria/generateEvaluationcriteriarouter.Generate Evaluation Criteria

Parameters

Name	In	Type	Required	Description
`evaluation_criteria_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://api.example.com/api/evaluation-criteria/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/evaluation-criteria/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

PUT/api/evaluation-criteria/loadEvaluationcriteriarouter.Load From Template

Parameters

Name	In	Type	Required	Description
`template_id`	body	`string`	Yes	None
`evaluation_criteria_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 PUT "https://api.example.com/api/evaluation-criteria/load" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "template_id": "00000000-0000-0000-0000-000000000000",
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/evaluation-criteria/load",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "template_id": "00000000-0000-0000-0000-000000000000",
        "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/evaluation-criteria/score/attributes/Evaluationcriteriascoreattributerouter.Get Evaluation Criteria Score Attributes

Parameters

Name	In	Type	Required	Description
`evaluation_criteria_score_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	`ListEvaluationCriteriaScoreAttributeResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListEvaluationCriteriaScoreAttributeResponse

Name	In	Type	Required	Description
`criteria_scores`	body	`array<EvaluationCriteriaScoreAttributeResponse>`	Yes	None
`criteria_scores[].id`	body	`string`	Yes	None
`criteria_scores[].user_id`	body	`string`	Yes	None
`criteria_scores[].operation_id`	body	`string`	Yes	None
`criteria_scores[].coa_statement_id`	body	`string`	Yes	None
`criteria_scores[].evaluation_criteria_score_id`	body	`string`	Yes	None
`criteria_scores[].title`	body	`string \| null`	Yes	None
`criteria_scores[].definition`	body	`string \| null`	Yes	None
`criteria_scores[].unit_of_measure`	body	`string \| null`	Yes	None
`criteria_scores[].benchmark`	body	`string \| null`	Yes	None
`criteria_scores[].formula_name`	body	`string \| null`	Yes	None
`criteria_scores[].formula_function`	body	`string \| null`	Yes	None
`criteria_scores[].formula_coefficient`	body	`number \| null`	Yes	None
`criteria_scores[].grade`	body	`number \| null`	Yes	None
`criteria_scores[].reasoning`	body	`string \| null`	Yes	None
`criteria_scores[].created_at`	body	`string \| null`	No	None
`criteria_scores[].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://api.example.com/api/evaluation-criteria/score/attributes/?evaluation_criteria_score_id=<evaluation_criteria_score_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/score/attributes/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "criteria_scores": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "evaluation_criteria_score_id": "00000000-0000-0000-0000-000000000000",
      "title": {},
      "definition": {},
      "unit_of_measure": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/evaluation-criteria/scores/Evaluationcriteriascorerouter.Gets

Parameters

Name	In	Type	Required	Description
`coa_statement_ids`	query	`array<string>`	Yes	None
`size`	query	`integer \| null`	No	None
`page`	query	`integer \| null`	No	None

Responses

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

Response body

200application/jsonListEvaluationCriteriaScoreResponse

Name	In	Type	Required	Description
`scores`	body	`array<EvaluationCriteriaScoreResponse>`	Yes	None
`scores[].id`	body	`string`	Yes	None
`scores[].user_id`	body	`string`	Yes	None
`scores[].operation_id`	body	`string`	Yes	None
`scores[].coa_statement_id`	body	`string`	Yes	None
`scores[].coa_statement_name`	body	`string`	Yes	None
`scores[].score`	body	`number \| null`	Yes	None
`scores[].summary`	body	`string \| null`	Yes	None
`scores[].status`	body	`WorkerStatus \| null`	Yes	None
`scores[].created_at`	body	`string \| null`	No	None
`scores[].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://api.example.com/api/evaluation-criteria/scores/?coa_statement_ids=<coa_statement_ids>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/scores/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "scores": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_name": "string",
      "score": {},
      "summary": {},
      "status": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/evaluation-criteria/scores/{evaluation_criteria_score_id}Evaluationcriteriascorerouter.Get

Parameters

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

Responses

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

Response body

200application/jsonEvaluationCriteriaScoreResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`coa_statement_name`	body	`string`	Yes	None
`score`	body	`number \| null`	Yes	None
`summary`	body	`string \| null`	Yes	None
`status`	body	`WorkerStatus \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/evaluation-criteria/scores/<evaluation_criteria_score_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/scores/<evaluation_criteria_score_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_name": "string",
  "score": 0,
  "summary": "string",
  "status": "processing"
}

POST/api/evaluation-criteria/scores/generateEvaluationcriteriascorerouter.Generate

Parameters

Name	In	Type	Required	Description
`coa_statement_ids`	body	`array<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://api.example.com/api/evaluation-criteria/scores/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "coa_statement_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/evaluation-criteria/scores/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "coa_statement_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/evaluation-criteria/templates/Evaluationcriteriatemplaterouter.Create Evaluation Criteria Template

Parameters

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

Responses

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

Response body

200application/jsonEvaluationCriteriaTemplateResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`evaluation_criteria_id`	body	`string`	Yes	None
`extra_information`	body	`string \| null`	Yes	None
`formula_grading`	body	`FormulaGrading`	Yes	None
`name`	body	`string`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/evaluation-criteria/templates/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
  "name": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/evaluation-criteria/templates/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
  "extra_information": "string",
  "formula_grading": "Lower is better",
  "name": "string",
  "created_at": "2026-06-01T00:00:00Z"
}

GET/api/evaluation-criteria/templates/Evaluationcriteriatemplaterouter.Get Evaluation Criteria Templates

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	`ListEvaluationCriteriaTemplateResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListEvaluationCriteriaTemplateResponse

Name	In	Type	Required	Description
`templates`	body	`array<EvaluationCriteriaTemplateResponse>`	Yes	None
`templates[].id`	body	`string`	Yes	None
`templates[].user_id`	body	`string`	Yes	None
`templates[].operation_id`	body	`string`	Yes	None
`templates[].evaluation_criteria_id`	body	`string`	Yes	None
`templates[].extra_information`	body	`string \| null`	Yes	None
`templates[].formula_grading`	body	`FormulaGrading`	Yes	None
`templates[].name`	body	`string`	Yes	None
`templates[].created_at`	body	`string \| null`	No	None
`templates[].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://api.example.com/api/evaluation-criteria/templates/?operation_id=<operation_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/evaluation-criteria/templates/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "templates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "evaluation_criteria_id": "00000000-0000-0000-0000-000000000000",
      "extra_information": {},
      "formula_grading": "Lower is better",
      "name": "string",
      "created_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

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://api.example.com/api/groups/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.com/api/groups/<group_id>/members?size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.com/api/groups/members?size=<size>&page=<page>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/groups/members/<group_member_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/health/" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.com/api/jobs/cancel/<job_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://api.example.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

Language

ShellPython

Shell

curl -X POST "https://api.example.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://api.example.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": {}
}

LLM Simulations5 operations

POST/api/llm-simulations/Llmsimulationrouter.Create Llm Simulation

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`guidelines`	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 POST "https://api.example.com/api/llm-simulations/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/llm-simulations/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "coa_statement_id": "00000000-0000-0000-0000-000000000000",
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/llm-simulations/Llmsimulationrouter.Get Llm Simulations

Parameters

Name	In	Type	Required	Description
`coa_statement_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	`ListLLMSimulationResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListLLMSimulationResponse

Name	In	Type	Required	Description
`llm_simulations`	body	`array<LLMSimulationResponse>`	Yes	None
`llm_simulations[].id`	body	`string`	Yes	None
`llm_simulations[].user_id`	body	`string`	Yes	None
`llm_simulations[].operation_id`	body	`string`	Yes	None
`llm_simulations[].coa_statement_id`	body	`string`	Yes	None
`llm_simulations[].synchronization_matrix`	body	`array<Matrix> \| null`	Yes	None
`llm_simulations[].likely_and_dangerous`	body	`array<LikelyAndDangerous> \| string \| null`	Yes	None
`llm_simulations[].obstacle`	body	`array<Obstacle> \| null`	Yes	None
`llm_simulations[].guidelines`	body	`string \| null`	Yes	None
`llm_simulations[].version`	body	`string`	Yes	None
`llm_simulations[].status`	body	`WorkerStatus \| null`	Yes	None
`llm_simulations[].created_at`	body	`string \| null`	No	None
`llm_simulations[].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://api.example.com/api/llm-simulations/?coa_statement_id=<coa_statement_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/llm-simulations/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "llm_simulations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "synchronization_matrix": {},
      "likely_and_dangerous": {},
      "obstacle": {},
      "guidelines": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/llm-simulations/{llm_simulation_id}Llmsimulationrouter.Get Llm Simulation

Parameters

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

Responses

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

Response body

200application/jsonLLMSimulationResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`synchronization_matrix`	body	`array<Matrix> \| null`	Yes	None
`synchronization_matrix[].time_interval`	body	`string`	No	None
`synchronization_matrix[].key_decision_point`	body	`string`	No	None
`synchronization_matrix[].maneuvers`	body	`string`	No	None
`synchronization_matrix[].fires`	body	`string`	No	None
`likely_and_dangerous`	body	`array<LikelyAndDangerous> \| string \| null`	Yes	None
`likely_and_dangerous[].phase`	body	`string`	No	None
`likely_and_dangerous[].decision_point`	body	`string`	No	None
`likely_and_dangerous[].obstacle`	body	`string`	No	None
`obstacle`	body	`array<Obstacle> \| null`	Yes	None
`obstacle[].action`	body	`string`	Yes	None
`obstacle[].obstacle_action`	body	`array<ObstacleAction>`	Yes	None
`obstacle[].decision_point`	body	`string`	Yes	None
`obstacle[].phase`	body	`integer`	Yes	None
`guidelines`	body	`string \| null`	Yes	None
`version`	body	`string`	Yes	None
`status`	body	`WorkerStatus \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/llm-simulations/<llm_simulation_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/llm-simulations/<llm_simulation_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "synchronization_matrix": [
    {
      "time_interval": {},
      "key_decision_point": {},
      "maneuvers": {},
      "fires": {}
    }
  ],
  "likely_and_dangerous": [
    {
      "phase": {},
      "decision_point": {},
      "obstacle": {}
    }
  ],
  "obstacle": [
    {
      "action": {},
      "obstacle_action": {},
      "decision_point": {},
      "phase": {}
    }
  ],
  "guidelines": "string"
}

DELETE/api/llm-simulations/{llm_simulation_id}Llmsimulationrouter.Delete Llm Simulation

Parameters

Name	In	Type	Required	Description
`llm_simulation_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://api.example.com/api/llm-simulations/<llm_simulation_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/llm-simulations/<llm_simulation_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/llm-simulations/{llm_simulation_id}/discussionDiscussionrouter.Get Discussion

Parameters

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

Responses

Name	In	Type	Required	Description
`200`	application/json	`array<DiscussionResponse>`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonarray<DiscussionResponse>

Name	In	Type	Required	Description
`body`	body	`array<DiscussionResponse>`	Yes	None
`body[].id`	body	`string`	Yes	None
`body[].operation_id`	body	`string`	Yes	None
`body[].coa_statement_id`	body	`string`	Yes	None
`body[].llm_simulation_id`	body	`string`	Yes	None
`body[].user_id`	body	`string`	Yes	None
`body[].title`	body	`string`	Yes	None
`body[].content`	body	`string`	Yes	None
`body[].index`	body	`integer`	Yes	None
`body[].phase`	body	`integer`	Yes	None
`body[].created_at`	body	`string \| null`	No	None
`body[].updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/llm-simulations/<llm_simulation_id>/discussion" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/llm-simulations/<llm_simulation_id>/discussion",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "operation_id": "00000000-0000-0000-0000-000000000000",
    "coa_statement_id": "00000000-0000-0000-0000-000000000000",
    "llm_simulation_id": "00000000-0000-0000-0000-000000000000",
    "user_id": "00000000-0000-0000-0000-000000000000",
    "title": "string",
    "content": "string",
    "index": 0
  }
]

Maps9 operations

POST/api/map-layers/Maplayerrouter.Create Layer

Parameters

Name	In	Type	Required	Description
`map_id`	body	`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	`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://api.example.com/api/map-layers/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "name": [
    "untitled"
  ],
  "layer_type": "none",
  "json_data": {},
  "extra_data": {}
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/map-layers/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "name": [
            "untitled"
        ],
        "layer_type": "none",
        "json_data": {},
        "extra_data": {}
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/map-layers/Maplayerrouter.Get Map Layers

Parameters

Name	In	Type	Required	Description
`map_id`	query	`string \| null`	No	None
`layer_type`	query	`MapLayerType \| null`	No	None
`meta_only`	query	`boolean`	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
`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://api.example.com/api/map-layers/?map_id=<map_id>&layer_type=<layer_type>&meta_only=<meta_only>&size=<size>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/map-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
  }
}

GET/api/map-layers/{map_layer_id}Maplayerrouter.Get Map Layer

Parameters

Name	In	Type	Required	Description
`map_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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/map-layers/<map_layer_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/map-layers/<map_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": {}
}

PUT/api/map-layers/{map_layer_id}Maplayerrouter.Update Map Layer

Parameters

Name	In	Type	Required	Description
`map_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

Language

ShellPython

Shell

curl -X PUT "https://api.example.com/api/map-layers/<map_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.put(
    "https://api.example.com/api/map-layers/<map_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/map-layers/{map_layer_id}Maplayerrouter.Delete Map Layer

Parameters

Name	In	Type	Required	Description
`map_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

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/map-layers/<map_layer_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/map-layers/<map_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": {}
}

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://api.example.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://api.example.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://api.example.com/api/maps/?operation_id=<operation_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.com/api/maps/<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "message": "Sucessful"
}

Mission Analysis7 operations

GET/api/mission-analysis/Missionanalysisrouter.Get Mission Analysis

Parameters

Name	In	Type	Required	Description
`operation_id`	query	`string`	Yes	None
`type`	query	`MissionAnalysisAvailable`	Yes	None

Responses

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

Response body

200application/jsonMissionAnalysisResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`content`	body	`string \| null`	Yes	None
`generated_output`	body	`string \| null`	Yes	None
`guidelines`	body	`string \| null`	Yes	None
`type`	body	`string`	Yes	None
`status`	body	`WorkerStatus \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/mission-analysis/?operation_id=<operation_id>&type=<type>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/mission-analysis/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "generated_output": "string",
  "guidelines": "string",
  "type": "string",
  "status": "processing"
}

PUT/api/mission-analysis/{mission_analysis_id}Missionanalysisrouter.Update Mission Analysis

Parameters

Name	In	Type	Required	Description
`mission_analysis_id`	path	`string`	Yes	None
`content`	body	`string \| null`	No	None
`guidelines`	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://api.example.com/api/mission-analysis/<mission_analysis_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "guidelines": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/mission-analysis/<mission_analysis_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "content": "string",
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/mission-analysis/{mission_analysis_id}/generateMissionanalysisrouter.Generate Single Mission Analysis

Parameters

Name	In	Type	Required	Description
`mission_analysis_id`	path	`string`	Yes	None
`guidelines`	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://api.example.com/api/mission-analysis/<mission_analysis_id>/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/mission-analysis/<mission_analysis_id>/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/mission-analysis/fieldsMissionanalysisrouter.Get Available Fields

Parameters

This endpoint does not declare parameters or a request body.

Responses

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

Response body

200application/jsonarray<MissionAnalysisAvailable>

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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/mission-analysis/fields" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/mission-analysis/fields",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  "Situation"
]

GET/api/mission-analysis/files/Selectedfilerouter.Get Selected Files

Parameters

Name	In	Type	Required	Description
`mission_analysis_id`	query	`string`	Yes	None
`select_type`	query	`SelectedFileType`	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	`WorkerStatus \| 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://api.example.com/api/mission-analysis/files/?mission_analysis_id=<mission_analysis_id>&select_type=<select_type>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/mission-analysis/files/",
    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
  }
}

PUT/api/mission-analysis/files/Selectedfilerouter.Update Selected File

Parameters

Name	In	Type	Required	Description
`mission_analysis_id`	body	`string`	Yes	None
`document_ids`	body	`array<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://api.example.com/api/mission-analysis/files/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "mission_analysis_id": "00000000-0000-0000-0000-000000000000",
  "document_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/mission-analysis/files/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "mission_analysis_id": "00000000-0000-0000-0000-000000000000",
        "document_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/mission-analysis/generateMissionanalysisrouter.Generate Mission Analysis

Parameters

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

Responses

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

Response body

200application/jsonGenerateMissionAnalysisResponse

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

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/mission-analysis/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/mission-analysis/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "mission_analysis_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.com/api/mss/rank",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "weights": {}
    },
)
print(response.json())

Example response

{}

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
`status`	body	`WorkerStatus \| null`	Yes	None
`policies`	body	`array<string>`	Yes	None
`state`	body	`StepperType \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://api.example.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://api.example.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[].status`	body	`WorkerStatus \| null`	Yes	None
`operations[].policies`	body	`array<string>`	Yes	None
`operations[].state`	body	`StepperType \| null`	No	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://api.example.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://api.example.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://api.example.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://api.example.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
`status`	body	`WorkerStatus \| null`	Yes	None
`policies`	body	`array<string>`	Yes	None
`state`	body	`StepperType \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

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

Python

import requests

response = requests.get(
    "https://api.example.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
`status`	body	`WorkerStatus \| null`	Yes	None
`policies`	body	`array<string>`	Yes	None
`state`	body	`StepperType \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

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

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/operations/<operation_id>/generated-maps/<asset_path>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.com/api/operations/<operation_id>/members?size=<size>&page=<page>&query=<query>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.com/api/operations/<operation_id>/members/<operation_member_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "message": "Sucessful"
}

OPORD10 operations

GET/api/opords/Opordrouter.Get Opord

Parameters

Name	In	Type	Required	Description
`operation_id`	query	`string`	Yes	None
`coa_statement_id`	query	`string`	Yes	None

Responses

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

Response body

200application/jsonOPORDResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`operation_name`	body	`string \| null`	Yes	None
`operation_number`	body	`string \| null`	Yes	None
`time_zone`	body	`string \| null`	Yes	None
`place_of_issue`	body	`string \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/opords/?operation_id=<operation_id>&coa_statement_id=<coa_statement_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "operation_name": "string",
  "operation_number": "string",
  "time_zone": "string",
  "place_of_issue": "string"
}

PUT/api/opords/{opord_id}Opordrouter.Update Opord

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`operation_name`	body	`string \| null`	No	None
`operation_number`	body	`string \| null`	No	None
`time_zone`	body	`string \| null`	No	None
`place_of_issue`	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://api.example.com/api/opords/<opord_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_name": "string",
  "operation_number": "string",
  "time_zone": "string",
  "place_of_issue": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/opords/<opord_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_name": "string",
        "operation_number": "string",
        "time_zone": "string",
        "place_of_issue": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

PUT/api/opords/{opord_id}/{attribute_id}Opordattributerouter.Update Opord Attribute

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`attribute_id`	path	`string`	Yes	None
`content`	body	`string \| array<string> \| null`	No	None
`classification`	body	`OPORDClassification \| null`	No	None
`section_name`	body	`string \| null`	No	None
`section_type`	body	`MissionAnalysisAvailable \| COAStatementAvailable \| string \| null`	No	None
`stepper_type`	body	`StepperType \| 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://api.example.com/api/opords/<opord_id>/<attribute_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "classification": "Unclassified",
  "section_name": "string",
  "section_type": "Situation",
  "stepper_type": "Mission Analysis"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/opords/<opord_id>/<attribute_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "content": "string",
        "classification": "Unclassified",
        "section_name": "string",
        "section_type": "Situation",
        "stepper_type": "Mission Analysis"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/opords/{opord_id}/{attribute_id}Opordattributerouter.Get Opord Attribute

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`attribute_id`	path	`string`	Yes	None

Responses

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

Response body

200application/jsonOPORDAttributeResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`opord_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	Yes	None
`content`	body	`string \| array<string> \| null`	Yes	None
`type`	body	`OPORDAvailable`	Yes	None
`classification`	body	`OPORDClassification`	Yes	None
`section_name`	body	`string \| null`	Yes	None
`section_type`	body	`string \| null`	Yes	None
`stepper_type`	body	`string \| null`	Yes	None
`attribute_order`	body	`integer \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/opords/<opord_id>/<attribute_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/opords/<opord_id>/<attribute_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "opord_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "type": "References"
}

POST/api/opords/{opord_id}/{attribute_id}/fill-latestOpordattributerouter.Fill Opord Attribute

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`attribute_id`	path	`string`	Yes	None

Responses

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

Response body

200application/jsonOPORDAttributeResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`opord_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	Yes	None
`content`	body	`string \| array<string> \| null`	Yes	None
`type`	body	`OPORDAvailable`	Yes	None
`classification`	body	`OPORDClassification`	Yes	None
`section_name`	body	`string \| null`	Yes	None
`section_type`	body	`string \| null`	Yes	None
`stepper_type`	body	`string \| null`	Yes	None
`attribute_order`	body	`integer \| null`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/opords/<opord_id>/<attribute_id>/fill-latest" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://api.example.com/api/opords/<opord_id>/<attribute_id>/fill-latest",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "opord_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "type": "References"
}

POST/api/opords/{opord_id}/attributesOpordattributerouter.Create Opord Attribute

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`parent_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://api.example.com/api/opords/<opord_id>/attributes" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "parent_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/opords/<opord_id>/attributes",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "parent_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/opords/{opord_id}/attributesOpordattributerouter.Get Opord Attributes

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`parent_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	`ListOPORDAttributeResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListOPORDAttributeResponse

Name	In	Type	Required	Description
`opord_attributes`	body	`array<OPORDAttributeResponse>`	Yes	None
`opord_attributes[].id`	body	`string`	Yes	None
`opord_attributes[].user_id`	body	`string`	Yes	None
`opord_attributes[].operation_id`	body	`string`	Yes	None
`opord_attributes[].opord_id`	body	`string`	Yes	None
`opord_attributes[].coa_statement_id`	body	`string`	Yes	None
`opord_attributes[].parent_id`	body	`string \| null`	Yes	None
`opord_attributes[].content`	body	`string \| array<string> \| null`	Yes	None
`opord_attributes[].type`	body	`OPORDAvailable`	Yes	None
`opord_attributes[].classification`	body	`OPORDClassification`	Yes	None
`opord_attributes[].section_name`	body	`string \| null`	Yes	None
`opord_attributes[].section_type`	body	`string \| null`	Yes	None
`opord_attributes[].stepper_type`	body	`string \| null`	Yes	None
`opord_attributes[].attribute_order`	body	`integer \| null`	Yes	None
`opord_attributes[].created_at`	body	`string \| null`	No	None
`opord_attributes[].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://api.example.com/api/opords/<opord_id>/attributes?parent_id=<parent_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/opords/<opord_id>/attributes",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "opord_attributes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "opord_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "parent_id": {},
      "content": {},
      "type": "References"
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/opords/{opord_id}/exportOpordrouter.Export

Parameters

Name	In	Type	Required	Description
`opord_id`	path	`string`	Yes	None
`type`	body	`OPORDExportType`	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	`WorkerStatus \| 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 POST "https://api.example.com/api/opords/<opord_id>/export" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "docx"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/opords/<opord_id>/export",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "type": "docx"
    },
)
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/opords/fieldsOpordrouter.Get Available Fields

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	`object`	No	None
`{key}.{key}`	body	`array<OPORDAvailable>`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/opords/fields" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/opords/fields",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/opords/time-zonesOpordrouter.Get Time Zones

Parameters

This endpoint does not declare parameters or a request body.

Responses

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

Response body

200application/jsonarray<string>

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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/opords/time-zones" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/opords/time-zones",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

[
  "string"
]

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://api.example.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://api.example.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"
    }
  ]
}

Presentations15 operations

GET/api/slide-decks/Slidedeckrouter.Get Slide Decks

Parameters

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

Responses

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

Response body

200application/jsonListSlideDeckResponse

Name	In	Type	Required	Description
`slide_decks`	body	`array<SlideDeckResponse>`	Yes	None
`slide_decks[].id`	body	`string`	Yes	None
`slide_decks[].user_id`	body	`string`	Yes	None
`slide_decks[].operation_id`	body	`string`	Yes	None
`slide_decks[].source_id`	body	`string`	Yes	None
`slide_decks[].type`	body	`SlideDeckType`	Yes	None
`slide_decks[].source_type`	body	`SlideSourceType`	Yes	None
`slide_decks[].created_at`	body	`string \| null`	No	None
`slide_decks[].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://api.example.com/api/slide-decks/?operation_id=<operation_id>&source_type=<source_type>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-decks/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "slide_decks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "source_id": "00000000-0000-0000-0000-000000000000",
      "type": "Mission Analysis Brief",
      "source_type": "mission_analysis",
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/slide-decks/downloadSlidedeckrouter.Download

Parameters

Name	In	Type	Required	Description
`slide_deck_id`	body	`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	`WorkerStatus \| 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 POST "https://api.example.com/api/slide-decks/download" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "slide_deck_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/slide-decks/download",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "slide_deck_id": "00000000-0000-0000-0000-000000000000"
    },
)
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/slide-decks/from-sourceSlidedeckrouter.Get Slide Deck From Source

Parameters

Name	In	Type	Required	Description
`source_id`	query	`string`	Yes	None
`source_type`	query	`SlideSourceType`	Yes	None
`slide_deck_type`	query	`SlideDeckType`	Yes	None

Responses

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

Response body

200application/jsonSlideDeckResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`source_id`	body	`string`	Yes	None
`type`	body	`SlideDeckType`	Yes	None
`source_type`	body	`SlideSourceType`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/slide-decks/from-source?source_id=<source_id>&source_type=<source_type>&slide_deck_type=<slide_deck_type>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-decks/from-source",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "source_id": "00000000-0000-0000-0000-000000000000",
  "type": "Mission Analysis Brief",
  "source_type": "mission_analysis",
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

POST/api/slide-items/Slideitemrouter.Create Item

Parameters

Name	In	Type	Required	Description
`page_id`	body	`string`	Yes	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	No	None
`item_type`	body	`SlideItemType`	Yes	None
`alignment`	body	`SlideItemAlignment`	No	None

Responses

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

Response body

200application/jsonSlideItemResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`attribute_id`	body	`string \| null`	No	None
`content`	body	`string \| null`	No	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	Yes	None
`type`	body	`SlideItemType`	Yes	None
`source`	body	`SlideItemSource`	Yes	None
`alignment`	body	`SlideItemAlignment`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/slide-items/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "page_id": "00000000-0000-0000-0000-000000000000",
  "ptop": 0,
  "pleft": 0,
  "width": 0,
  "height": 0,
  "font_size": 0,
  "item_type": "image",
  "alignment": "left"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/slide-items/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "page_id": "00000000-0000-0000-0000-000000000000",
        "ptop": 0,
        "pleft": 0,
        "width": 0,
        "height": 0,
        "font_size": 0,
        "item_type": "image",
        "alignment": "left"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "ptop": 0
}

GET/api/slide-items/Slideitemrouter.Get Items

Parameters

Name	In	Type	Required	Description
`slide_deck_id`	query	`string`	Yes	None
`page_id`	query	`string \| null`	No	None
`size`	query	`integer \| null`	No	None
`item`	query	`integer \| null`	No	None

Responses

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

Response body

200application/jsonListSlideItemResponse

Name	In	Type	Required	Description
`items`	body	`array<SlideItemResponse>`	Yes	None
`items[].id`	body	`string`	Yes	None
`items[].user_id`	body	`string`	Yes	None
`items[].operation_id`	body	`string`	Yes	None
`items[].slide_deck_id`	body	`string`	Yes	None
`items[].page_id`	body	`string`	Yes	None
`items[].attribute_id`	body	`string \| null`	No	None
`items[].content`	body	`string \| null`	No	None
`items[].ptop`	body	`integer`	Yes	None
`items[].pleft`	body	`integer`	Yes	None
`items[].width`	body	`integer`	Yes	None
`items[].height`	body	`integer`	Yes	None
`items[].font_size`	body	`integer \| null`	Yes	None
`items[].type`	body	`SlideItemType`	Yes	None
`items[].source`	body	`SlideItemSource`	Yes	None
`items[].alignment`	body	`SlideItemAlignment`	Yes	None
`items[].created_at`	body	`string \| null`	No	None
`items[].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://api.example.com/api/slide-items/?slide_deck_id=<slide_deck_id>&page_id=<page_id>&size=<size>&item=<item>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-items/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "slide_deck_id": "00000000-0000-0000-0000-000000000000",
      "page_id": "00000000-0000-0000-0000-000000000000",
      "attribute_id": {},
      "content": {},
      "ptop": 0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

PUT/api/slide-items/{item_id}Slideitemrouter.Update Item

Parameters

Name	In	Type	Required	Description
`item_id`	path	`string`	Yes	None
`ptop`	body	`integer \| null`	No	None
`pleft`	body	`integer \| null`	No	None
`width`	body	`integer \| null`	No	None
`height`	body	`integer \| null`	No	None
`content`	body	`string \| null`	No	None
`font_size`	body	`integer \| null`	No	None
`alignment`	body	`SlideItemAlignment \| null`	No	None

Responses

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

Response body

200application/jsonSlideItemResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`attribute_id`	body	`string \| null`	No	None
`content`	body	`string \| null`	No	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	Yes	None
`type`	body	`SlideItemType`	Yes	None
`source`	body	`SlideItemSource`	Yes	None
`alignment`	body	`SlideItemAlignment`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X PUT "https://api.example.com/api/slide-items/<item_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "ptop": 0,
  "pleft": 0,
  "width": 0,
  "height": 0,
  "content": "string",
  "font_size": 0,
  "alignment": "left"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/slide-items/<item_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "ptop": 0,
        "pleft": 0,
        "width": 0,
        "height": 0,
        "content": "string",
        "font_size": 0,
        "alignment": "left"
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "ptop": 0
}

GET/api/slide-items/{item_id}Slideitemrouter.Get Item

Parameters

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

Responses

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

Response body

200application/jsonSlideItemResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`attribute_id`	body	`string \| null`	No	None
`content`	body	`string \| null`	No	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	Yes	None
`type`	body	`SlideItemType`	Yes	None
`source`	body	`SlideItemSource`	Yes	None
`alignment`	body	`SlideItemAlignment`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/slide-items/<item_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-items/<item_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "ptop": 0
}

DELETE/api/slide-items/{item_id}Slideitemrouter.Delete Item

Parameters

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

Responses

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

Response body

200application/jsonSlideItemResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`attribute_id`	body	`string \| null`	No	None
`content`	body	`string \| null`	No	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	Yes	None
`type`	body	`SlideItemType`	Yes	None
`source`	body	`SlideItemSource`	Yes	None
`alignment`	body	`SlideItemAlignment`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/slide-items/<item_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/slide-items/<item_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "ptop": 0
}

GET/api/slide-items/{item_id}/imageSlideitemrouter.Get Image

Parameters

Name	In	Type	Required	Description
`item_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://api.example.com/api/slide-items/<item_id>/image" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-items/<item_id>/image",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/slide-items/imagesSlideitemrouter.Create Image

Parameters

Name	In	Type	Required	Description
`upload_file`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer`	Yes	None

Responses

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

Response body

200application/jsonSlideItemResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_id`	body	`string`	Yes	None
`attribute_id`	body	`string \| null`	No	None
`content`	body	`string \| null`	No	None
`ptop`	body	`integer`	Yes	None
`pleft`	body	`integer`	Yes	None
`width`	body	`integer`	Yes	None
`height`	body	`integer`	Yes	None
`font_size`	body	`integer \| null`	Yes	None
`type`	body	`SlideItemType`	Yes	None
`source`	body	`SlideItemSource`	Yes	None
`alignment`	body	`SlideItemAlignment`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/slide-items/images" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "upload_file": "string",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "ptop": 0,
  "pleft": 0,
  "width": 0,
  "height": 0,
  "font_size": 0
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/slide-items/images",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "upload_file": "string",
        "page_id": "00000000-0000-0000-0000-000000000000",
        "ptop": 0,
        "pleft": 0,
        "width": 0,
        "height": 0,
        "font_size": 0
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_id": "00000000-0000-0000-0000-000000000000",
  "attribute_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "ptop": 0
}

POST/api/slide-pages/Slidepagerouter.Create Page

Parameters

Name	In	Type	Required	Description
`slide_deck_id`	body	`string`	Yes	None
`page_order`	body	`integer`	Yes	None

Responses

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

Response body

200application/jsonSlidePageResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_order`	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://api.example.com/api/slide-pages/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_order": 0
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/slide-pages/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "slide_deck_id": "00000000-0000-0000-0000-000000000000",
        "page_order": 0
    },
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_order": 0,
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

GET/api/slide-pages/Slidepagerouter.Get Pages

Parameters

Name	In	Type	Required	Description
`slide_deck_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	`ListSlidePageResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListSlidePageResponse

Name	In	Type	Required	Description
`pages`	body	`array<SlidePageResponse>`	Yes	None
`pages[].id`	body	`string`	Yes	None
`pages[].user_id`	body	`string`	Yes	None
`pages[].operation_id`	body	`string`	Yes	None
`pages[].slide_deck_id`	body	`string`	Yes	None
`pages[].page_order`	body	`integer`	Yes	None
`pages[].created_at`	body	`string \| null`	No	None
`pages[].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://api.example.com/api/slide-pages/?slide_deck_id=<slide_deck_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-pages/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "pages": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "slide_deck_id": "00000000-0000-0000-0000-000000000000",
      "page_order": 0,
      "created_at": {},
      "updated_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/slide-pages/{page_id}Slidepagerouter.Get Page

Parameters

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

Responses

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

Response body

200application/jsonSlidePageResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_order`	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://api.example.com/api/slide-pages/<page_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/slide-pages/<page_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_order": 0,
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

DELETE/api/slide-pages/{page_id}Slidepagerouter.Delete Page

Parameters

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

Responses

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

Response body

200application/jsonSlidePageResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`slide_deck_id`	body	`string`	Yes	None
`page_order`	body	`integer`	Yes	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X DELETE "https://api.example.com/api/slide-pages/<page_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/slide-pages/<page_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "slide_deck_id": "00000000-0000-0000-0000-000000000000",
  "page_order": 0,
  "created_at": "2026-06-01T00:00:00Z",
  "updated_at": "2026-06-01T00:00:00Z"
}

POST/api/slide-pages/overwritesSlidepagerouter.Overwrite Page

Parameters

Name	In	Type	Required	Description
`page_id`	body	`string`	Yes	None
`items`	body	`array<OverwriteItem>`	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://api.example.com/api/slide-pages/overwrites" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "page_id": "00000000-0000-0000-0000-000000000000",
  "items": [
    {
      "ptop": 0,
      "pleft": 0,
      "width": 0,
      "height": 0,
      "font_size": {},
      "item_type": "image",
      "content": {},
      "alignment": "left"
    }
  ]
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/slide-pages/overwrites",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "page_id": "00000000-0000-0000-0000-000000000000",
        "items": [
            {
                "ptop": 0,
                "pleft": 0,
                "width": 0,
                "height": 0,
                "font_size": {},
                "item_type": "image",
                "content": {},
                "alignment": "left"
            }
        ]
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

Scenarios6 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

Language

ShellPython

Shell

curl -X POST "https://api.example.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://api.example.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": {}
}

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
`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://api.example.com/api/scenarios/?map_id=<map_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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": {}
    }
  ],
  "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

Language

ShellPython

Shell

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

Python

import requests

response = requests.get(
    "https://api.example.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": {}
}

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

Language

ShellPython

Shell

curl -X PUT "https://api.example.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://api.example.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": {}
}

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

Language

ShellPython

Shell

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

Python

import requests

response = requests.delete(
    "https://api.example.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": {}
}

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://api.example.com/api/scenarios/<scenario_id>/export-sync-matrix" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://api.example.com/api/scenarios/<scenario_id>/export-sync-matrix",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

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://api.example.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://api.example.com/api/soil/units",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

Terrain Analysis10 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

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
`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

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/terrain-analysis/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "boundary_shape": {},
  "map_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/terrain-analysis/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "boundary_shape": {},
        "map_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false,
  "overall": {}
}

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://api.example.com/api/terrain-analysis/chat/maps/<map_id>/sessions" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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
`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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/terrain-analysis/jobs/<job_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/terrain-analysis/jobs/<job_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false,
  "overall": {}
}

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
`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

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/terrain-analysis/jobs/<job_id>/cancel" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "errors": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false,
  "overall": {}
}

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
`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

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/terrain-analysis/jobs/latest?map_id=<map_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/terrain-analysis/jobs/latest",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "errors": [
    "string"
  ],
  "sources": {},
  "job_id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "analysis_ready": false,
  "display_ready": false,
  "can_cancel": false,
  "overall": {}
}

POST/api/terrain-analysis/radar-maskTerrainanalysisrouter.Radar Mask

Parameters

Name	In	Type	Required	Description
`map_id`	body	`string`	Yes	None
`radar_radius`	body	`number`	Yes	Radar radius in meters
`latitude`	body	`number`	Yes	None
`longitude`	body	`number`	Yes	None

Responses

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

Response body

200application/jsonGeoJSONFeatureCollectionResponse

Name	In	Type	Required	Description
`type`	body	`string`	No	None
`features`	body	`array<GeoJSONFeatureResponse>`	No	None
`features[].type`	body	`string`	No	None
`features[].geometry`	body	`GeoJSONPolygonGeometryResponse \| GeoJSONMultiPolygonGeometryResponse`	Yes	None
`features[].properties`	body	`RadarMaskFeaturePropertiesResponse`	Yes	None

Language

ShellPython

Shell

curl -X POST "https://api.example.com/api/terrain-analysis/radar-mask" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "map_id": "00000000-0000-0000-0000-000000000000",
  "radar_radius": 0,
  "latitude": 0,
  "longitude": 0
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/terrain-analysis/radar-mask",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "map_id": "00000000-0000-0000-0000-000000000000",
        "radar_radius": 0,
        "latitude": 0,
        "longitude": 0
    },
)
print(response.json())

Example response

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {},
      "properties": {
        "mask_type": {}
      }
    }
  ]
}

Terrain Tiles8 operations

GET/api/tiles/elevation-data/{z}/{x}/{y}.pngTerraintilesrouter.Elevation Data Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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://api.example.com/api/tiles/elevation-data/<z>/<x>/<y>.png" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/elevation-data/<z>/<x>/<y>.png",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/tiles/landcover-data/{z}/{x}/{y}.pngTerraintilesrouter.Landcover Data Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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://api.example.com/api/tiles/landcover-data/<z>/<x>/<y>.png" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/landcover-data/<z>/<x>/<y>.png",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/tiles/roads/{z}/{x}/{y}.mvtTerraintilesrouter.Road Mvt Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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://api.example.com/api/tiles/roads/<z>/<x>/<y>.mvt" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/roads/<z>/<x>/<y>.mvt",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

HEAD/api/tiles/roads/{z}/{x}/{y}.mvtTerraintilesrouter.Road Mvt Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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 HEAD "https://api.example.com/api/tiles/roads/<z>/<x>/<y>.mvt" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.head(
    "https://api.example.com/api/tiles/roads/<z>/<x>/<y>.mvt",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

POST/api/tiles/sessionTerraintilesrouter.Create Tile Session

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://api.example.com/api/tiles/session" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.post(
    "https://api.example.com/api/tiles/session",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/tiles/soil-artifact-debug/{z}/{x}/{y}.jsonTerraintilesrouter.Soil Artifact Debug Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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://api.example.com/api/tiles/soil-artifact-debug/<z>/<x>/<y>.json" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/soil-artifact-debug/<z>/<x>/<y>.json",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/tiles/soil/{z}/{x}/{y}.mvtTerraintilesrouter.Soil Mvt Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	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://api.example.com/api/tiles/soil/<z>/<x>/<y>.mvt" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/soil/<z>/<x>/<y>.mvt",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

GET/api/tiles/terrain-summary-debug/{z}/{x}/{y}.jsonTerraintilesrouter.Terrain Summary Debug Tile

Parameters

Name	In	Type	Required	Description
`z`	path	`integer`	Yes	None
`x`	path	`integer`	Yes	None
`y`	path	`integer`	Yes	None
`map_zoom`	query	`number \| 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://api.example.com/api/tiles/terrain-summary-debug/<z>/<x>/<y>.json?map_zoom=<map_zoom>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/tiles/terrain-summary-debug/<z>/<x>/<y>.json",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}

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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.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://api.example.com/api/units/<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/units/<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.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://api.example.com/api/units/<unit_id>/icon" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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://api.example.com/api/units/parents?unit_id=<unit_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.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
  }
}

Wargaming Sessions8 operations

POST/api/wargaming-sessions/Wargamingsessionrouter.Create Wargaming Session

Parameters

Name	In	Type	Required	Description
`operation_id`	body	`string`	Yes	None
`coa_statement_id`	body	`string`	Yes	None
`guidelines`	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 POST "https://api.example.com/api/wargaming-sessions/" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "coa_statement_id": "00000000-0000-0000-0000-000000000000",
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/wargaming-sessions/",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "operation_id": "00000000-0000-0000-0000-000000000000",
        "coa_statement_id": "00000000-0000-0000-0000-000000000000",
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/wargaming-sessions/Wargamingsessionrouter.Get Wargaming Sessions

Parameters

Name	In	Type	Required	Description
`coa_statement_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	`ListWargamingSessionResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListWargamingSessionResponse

Name	In	Type	Required	Description
`wargaming_sessions`	body	`array<WargamingSessionResponse>`	Yes	None
`wargaming_sessions[].id`	body	`string`	Yes	None
`wargaming_sessions[].user_id`	body	`string`	Yes	None
`wargaming_sessions[].operation_id`	body	`string`	Yes	None
`wargaming_sessions[].coa_statement_id`	body	`string`	Yes	None
`wargaming_sessions[].guidelines`	body	`string \| null`	Yes	None
`wargaming_sessions[].version`	body	`string`	Yes	None
`wargaming_sessions[].status`	body	`WorkerStatus \| null`	Yes	None
`wargaming_sessions[].created_at`	body	`string \| null`	No	None
`wargaming_sessions[].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://api.example.com/api/wargaming-sessions/?coa_statement_id=<coa_statement_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/wargaming-sessions/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "wargaming_sessions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "guidelines": {},
      "version": "string",
      "status": {},
      "created_at": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

DELETE/api/wargaming-sessions/{session_id}Wargamingsessionrouter.Delete Wargaming Session

Parameters

Name	In	Type	Required	Description
`session_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://api.example.com/api/wargaming-sessions/<session_id>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.delete(
    "https://api.example.com/api/wargaming-sessions/<session_id>",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/wargaming-sessions/attributes/Wargamingsessionattributerouter.Get Wargaming Session Attributes

Parameters

Name	In	Type	Required	Description
`wargaming_session_id`	query	`string`	Yes	None
`branch_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	`ListWargamingSessionAttributeResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListWargamingSessionAttributeResponse

Name	In	Type	Required	Description
`wargaming_session_attributes`	body	`array<WargamingSessionAttributeResponse>`	Yes	None
`wargaming_session_attributes[].id`	body	`string`	Yes	None
`wargaming_session_attributes[].user_id`	body	`string`	Yes	None
`wargaming_session_attributes[].operation_id`	body	`string`	Yes	None
`wargaming_session_attributes[].coa_statement_id`	body	`string`	Yes	None
`wargaming_session_attributes[].wargaming_session_id`	body	`string`	Yes	None
`wargaming_session_attributes[].branch_id`	body	`string`	Yes	None
`wargaming_session_attributes[].parent_id`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].phase`	body	`WargamingPhase`	Yes	None
`wargaming_session_attributes[].turn`	body	`integer`	Yes	None
`wargaming_session_attributes[].session_order`	body	`integer`	Yes	None
`wargaming_session_attributes[].facilitator`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].red`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].blue`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].red_observation`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].blue_observation`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].summary`	body	`string \| null`	Yes	None
`wargaming_session_attributes[].status`	body	`WorkerStatus \| null`	Yes	None
`wargaming_session_attributes[].created_at`	body	`string \| null`	No	None
`wargaming_session_attributes[].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://api.example.com/api/wargaming-sessions/attributes/?wargaming_session_id=<wargaming_session_id>&branch_id=<branch_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/wargaming-sessions/attributes/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "wargaming_session_attributes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "wargaming_session_id": "00000000-0000-0000-0000-000000000000",
      "branch_id": "00000000-0000-0000-0000-000000000000",
      "parent_id": {},
      "phase": "Preparation"
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

GET/api/wargaming-sessions/branches/Wargamingsessionbranchrouter.Get Wargaming Session Branches

Parameters

Name	In	Type	Required	Description
`wargaming_session_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	`ListWargamingSessionBranchResponse`	No	Successful Response
`422`	application/json	`HTTPValidationError`	No	Validation Error

Response body

200application/jsonListWargamingSessionBranchResponse

Name	In	Type	Required	Description
`branches`	body	`array<WargamingSessionBranchResponse>`	Yes	None
`branches[].id`	body	`string`	Yes	None
`branches[].user_id`	body	`string`	Yes	None
`branches[].operation_id`	body	`string`	Yes	None
`branches[].coa_statement_id`	body	`string`	Yes	None
`branches[].wargaming_session_id`	body	`string`	Yes	None
`branches[].parent_id`	body	`string \| null`	Yes	None
`branches[].origin_id`	body	`string \| null`	Yes	None
`branches[].post_analysis`	body	`string \| null`	Yes	None
`branches[].agent`	body	`WargamingAgent \| null`	Yes	None
`branches[].changes`	body	`string \| null`	Yes	None
`branches[].status`	body	`WorkerStatus \| null`	Yes	None
`branches[].created_at`	body	`string \| null`	No	None
`branches[].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://api.example.com/api/wargaming-sessions/branches/?wargaming_session_id=<wargaming_session_id>&size=<size>&page=<page>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/wargaming-sessions/branches/",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{
  "branches": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "operation_id": "00000000-0000-0000-0000-000000000000",
      "coa_statement_id": "00000000-0000-0000-0000-000000000000",
      "wargaming_session_id": "00000000-0000-0000-0000-000000000000",
      "parent_id": {},
      "origin_id": {},
      "post_analysis": {}
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total_records": 0
  }
}

POST/api/wargaming-sessions/branches/cancelWargamingsessionbranchrouter.Cancel Wargaming Session Branch

Parameters

Name	In	Type	Required	Description
`branch_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://api.example.com/api/wargaming-sessions/branches/cancel" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "branch_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/wargaming-sessions/branches/cancel",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "branch_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/wargaming-sessions/branches/generateWargamingsessionbranchrouter.Generate Wargaming Session Branch

Parameters

Name	In	Type	Required	Description
`origin_id`	body	`string`	Yes	None
`agent`	body	`WargamingAgent`	Yes	None
`changes`	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 POST "https://api.example.com/api/wargaming-sessions/branches/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "origin_id": "00000000-0000-0000-0000-000000000000",
  "agent": "Blue",
  "changes": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/wargaming-sessions/branches/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "origin_id": "00000000-0000-0000-0000-000000000000",
        "agent": "Blue",
        "changes": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/wargaming-sessions/branches/retryWargamingsessionbranchrouter.Retry Wargaming Session Branch

Parameters

Name	In	Type	Required	Description
`attribute_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://api.example.com/api/wargaming-sessions/branches/retry" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "attribute_id": "00000000-0000-0000-0000-000000000000"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/wargaming-sessions/branches/retry",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "attribute_id": "00000000-0000-0000-0000-000000000000"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

WARNO4 operations

GET/api/warno/Warnorouter.Get Warno

Parameters

Name	In	Type	Required	Description
`operation_id`	query	`string`	Yes	None
`type`	query	`WARNOAvailable`	Yes	None

Responses

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

Response body

200application/jsonWARNOResponse

Name	In	Type	Required	Description
`id`	body	`string`	Yes	None
`user_id`	body	`string`	Yes	None
`operation_id`	body	`string`	Yes	None
`parent_id`	body	`string \| null`	Yes	None
`content`	body	`string \| null`	Yes	None
`generated_output`	body	`string \| null`	Yes	None
`guidelines`	body	`string \| null`	Yes	None
`type`	body	`string`	Yes	None
`status`	body	`WorkerStatus \| null`	No	None
`created_at`	body	`string \| null`	No	None
`updated_at`	body	`string \| null`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/warno/?operation_id=<operation_id>&type=<type>" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

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

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "operation_id": "00000000-0000-0000-0000-000000000000",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "generated_output": "string",
  "guidelines": "string",
  "type": "string"
}

PUT/api/warno/{warno_id}Warnorouter.Update Warno

Parameters

Name	In	Type	Required	Description
`warno_id`	path	`string`	Yes	None
`content`	body	`string \| null`	No	None
`generated_output`	body	`string \| null`	No	None
`guidelines`	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://api.example.com/api/warno/<warno_id>" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "generated_output": "string",
  "guidelines": "string"
}'

Python

import requests

response = requests.put(
    "https://api.example.com/api/warno/<warno_id>",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "content": "string",
        "generated_output": "string",
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

POST/api/warno/{warno_id}/generateWarnorouter.Generate Single Warno

Parameters

Name	In	Type	Required	Description
`warno_id`	path	`string`	Yes	None
`guidelines`	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://api.example.com/api/warno/<warno_id>/generate" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "guidelines": "string"
}'

Python

import requests

response = requests.post(
    "https://api.example.com/api/warno/<warno_id>/generate",
    headers={"Authorization": "Bearer <api-key>"},
    json={
        "guidelines": "string"
    },
)
print(response.json())

Example response

{
  "message": "Sucessful"
}

GET/api/warno/fieldsWarnorouter.Get Available Fields

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<WARNOAvailable>`	No	None

Language

ShellPython

Shell

curl -X GET "https://api.example.com/api/warno/fields" \
  -H "Authorization: Bearer <api-key>"

Python

import requests

response = requests.get(
    "https://api.example.com/api/warno/fields",
    headers={"Authorization": "Bearer <api-key>"},
)
print(response.json())

Example response

{}