Base URL
http://client-omni-api.argosidentity.com/v1
If your organization restricts outbound traffic with a firewall or proxy, add client-omni-api.argosidentity.com to your allowlist for HTTP (port 80). Add port 443 if you use HTTPS.
Authentication
All requests require the x-api-key header:
-H "x-api-key: your-api-key-here"
API Structure
The Omni API follows the data hierarchy:
Project → Workflow → Profile → Folder → Item → Analysis
| Resource | Key Endpoints |
|---|
| Project | GET /v1/projects/:projectId |
| Workflow | GET /v1/workflows/:workflowId |
| Profile | POST, GET, PATCH, DELETE |
| Folder | POST, GET, PATCH, DELETE |
| Item | POST (upload), GET, PATCH, DELETE |
{
"success": true,
"data": { ... }
}
{
"error": {
"code": "ERROR_CODE",
"status": 400,
"message": "Human-readable error description"
}
}
Error Codes
| Status | Code | Description |
|---|
| 401 | UNAUTHORIZED | Invalid or missing API key |
| 404 | NOT_FOUND | Resource does not exist |
| 409 | CONFLICT | Duplicate resource or limit exceeded |
| 413 | PAYLOAD_TOO_LARGE | File size exceeds 10MB limit |
| 415 | UNSUPPORTED_MEDIA | Unsupported file type |
Resource-Specific Error Codes
| Code | Description |
|---|
ITEM_LIMIT_EXCEEDED | More than 5 items in a single folder |
FILE_TOO_LARGE | Uploaded file exceeds 10MB |
UNSUPPORTED_FILE_TYPE | File format not in the supported list |
GET /v1/workflows/{workflowId}/profiles?page=1&size=50
