Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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"
See Authentication for details on obtaining your API key.

​
API Structure

The Omni API follows the data hierarchy: 
Project → Workflow → Profile → Folder → Item → Analysis
ResourceKey Endpoints
ProjectGET /v1/projects/:projectId
WorkflowGET /v1/workflows/:workflowId
ProfilePOST, GET, PATCH, DELETE
FolderPOST, GET, PATCH, DELETE
ItemPOST (upload), GET, PATCH, DELETE

​
Common Response Format

All successful responses follow this pattern: 
{
  "success": true,
  "data": { ... }
}

​
Error Response Format

{
  "error": {
    "code": "ERROR_CODE",
    "status": 400,
    "message": "Human-readable error description"
  }
}

​
Error Codes

StatusCodeDescription
401UNAUTHORIZEDInvalid or missing API key
404NOT_FOUNDResource does not exist
409CONFLICTDuplicate resource or limit exceeded
413PAYLOAD_TOO_LARGEFile size exceeds 10MB limit
415UNSUPPORTED_MEDIAUnsupported file type

​
Resource-Specific Error Codes

CodeDescription
ITEM_LIMIT_EXCEEDEDMore than 5 items in a single folder
FILE_TOO_LARGEUploaded file exceeds 10MB
UNSUPPORTED_FILE_TYPEFile format not in the supported list

​
Pagination

List endpoints return paginated results with a default page size of 50 items. 
GET /v1/workflows/{workflowId}/profiles?page=1&size=50