Endpoints
| Method | Path | Description |
|---|---|---|
POST | /systems | Create a system |
GET | /systems | List systems |
GET | /systems/{system_id} | Get a system |
PUT | /systems/{system_id} | Update a system |
DELETE | /systems/{system_id} | Delete a system |
POST | /systems/upload_document | Upload a reference document |
GET | /system-memories | Search entity memories across a system |
Create a system
POST /systems
Request body:
| Field | Required | Type | Description |
|---|---|---|---|
system_name | Yes | string | Display name for the system |
description | No | string | Optional description |
| Field | Type | Nullable | Description |
|---|---|---|---|
system_id | UUID | No | Unique system identifier |
system_name | string | No | Display name |
description | string | Yes | System description |
has_blueprints | boolean | No | Whether the system has associated blueprints |
created_by | string | No | Email of the user who created the system |
created_at | string | No | ISO 8601 creation timestamp |
is_deleted | boolean | No | Soft-delete flag |
List systems
GET /systems
Query parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
search | No | string | Filter by name (case-insensitive substring match) |
is_deleted | No | boolean | Set to true to include soft-deleted systems. Defaults to false |
{"items": [...], "count": N} where each item is a system object with the same fields as the create response.
Get a system
GET /systems/{system_id}
Path parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
system_id | Yes | UUID | System identifier |
Update a system
PUT /systems/{system_id}
All fields are optional. Only provided fields are updated.
| Field | Type | Description |
|---|---|---|
system_name | string | New display name |
description | string | New description |
Delete a system
DELETE /systems/{system_id}
Soft-deletes a system. The system remains in the database with is_deleted: true.
Example request:
| Field | Type | Description |
|---|---|---|
message | string | Confirmation message |
uuid | UUID | ID of the deleted system |
Upload a reference document
POST /systems/upload_document
Attaches PDFs, specs, schematics, or other documents to a system. Uploaded files are embedded and made available to Atlas during reasoning and metagraph updates.
Query parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
system_id | No | UUID | System to scope the document to |
multipart/form-data):
| Field | Required | Description |
|---|---|---|
file | Yes | File binary. Use multiple file fields to upload several files at once |
metadata | No | JSON string with optional file_name (string) and file_type (string) |
| Field | Type | Description |
|---|---|---|
message | string | Summary message |
system_id | UUID | System the documents were attached to |
total_files | integer | Number of files submitted |
successful | integer | Number of files successfully processed |
failed | integer | Number of files that failed |
results | array | Per-file result objects |
results:
| Field | Type | Nullable | Description |
|---|---|---|---|
file_name | string | No | Name of the file |
success | boolean | No | Whether processing succeeded |
dataset_name | string | Yes | Dataset identifier assigned |
job_run_id | UUID | Yes | ID of the embedding job run |
error | string | Yes | Error message if failed |
Search system memories
GET /system-memories
Searches entity memories across all entities. Returns matching memory entries with their associated entity and system context.
Query parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
search | No | string | Keyword search across memory content |
entity_ids | No | array of UUID | Filter to specific entity IDs |
root_entity_ids | No | array of UUID | Filter to entities under specific root entities |
contributors | No | array of string | Filter by contributor email |
sort_by | No | string | Sort field |
offset | No | integer | Default 0 |
limit | No | integer | Default 20 |
| Field | Type | Description |
|---|---|---|
items | array | List of memory result objects |
count | integer | Total number of matching entries |
items:
| Field | Type | Description |
|---|---|---|
item.id | string | Memory entry identifier |
item.content | string | Memory text |
item.source | string | How the memory was created |
item.contributors | array of string | Emails of users who contributed |
item.created_at | string | ISO 8601 creation timestamp |
item.tags | array of string | Labels applied to this memory |
system_id | string | ID of the system the entity belongs to |
system_name | string | Name of the system |
entity_id | string | ID of the entity this memory is attached to |
entity_name | string | Display name of the entity |
entity_type | string | Entity type (e.g. COMPONENT, SUBSYSTEM) |

