API overview

The Omni API connects your Review Ops Agent’s reviews to your existing systems. You send the subject and its documents, and receive the decision, data, and grounds assembled to your output schema.

Base URL

https://client-omni-api.argosidentity.com/v1

If outbound traffic is restricted by a firewall or proxy, allow HTTPS (443) to client-omni-api.argosidentity.com.

Authentication

Every request carries the project API key in the x-api-key header. The key is issued once when the project is created and can be regenerated — see Authentication.

curl "https://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: your-api-key-here"

Keys are scoped to a single project. Requesting a resource from another project returns 403 OMNI_5001.

Resource structure

Project → Workflow → Profile → Folder → Item → Analysis

Resource	Endpoint	Notes
Project	`GET /projects/:projectId`	Read only. Create and configure in the dashboard
Workflow	`GET /workflows/:workflowId`, `GET /workflows/:workflowId/summary`	Read only. Create and edit in the dashboard
Profile	`POST` · `GET` · `PATCH` · `DELETE`	Lives under a workflow
Folder	`POST` · `GET` · `PATCH` · `DELETE`	A default folder is created with every profile
Item	`POST` · `GET` · `PATCH` · `DELETE`	File upload, or text and JSON content
Analysis	`POST` · `GET list` · `GET detail` · `DELETE` · `GET report`	Runs asynchronously

Response format

Read responses return the resource object directly — there is no wrapper field. List responses carry count and items, and some add nextCursor.

{
  "id": "proj_75hgxoxamzn9",
  "name": "Demo",
  "status": "trial"
}

All timestamps are ISO 8601 UTC (2026-09-10T04:23:56.000Z). Deletes return 204 No Content.

Error response format

Error bodies put code and message at the top level. Branch on code; treat message as display text only.

{
  "code": "OMNI_3004",
  "message": "Analysis not found"
}

Field	Type	Description
`code`	`string`	Error code with the `OMNI_` prefix
`message`	`string`	Human-readable explanation. Wording may change. Fixed to `Internal server error` for 500-class errors
`details`	`object \| array`	(optional) Extra information, present only for request validation failures and similar cases

Common error codes

Status	Code	Description
400	`OMNI_2101`	Request body, query, or uploaded file failed validation. The specific violation is in `message`
401	`OMNI_4001`	`x-api-key` header missing
401	`OMNI_4005`	Invalid or revoked API key
403	`OMNI_5001`	The resource does not belong to the key’s project
404	`OMNI_30xx`	Resource not found. See the per-resource table below
429	`OMNI_2004`	Daily analysis limit for trial projects (10) exceeded
500	`OMNI_6001`	Internal server error. Retry shortly; contact support if it persists

Per-resource error codes

Status	Code	Description	Where
404	`OMNI_3002`	Project not found	Project
404	`OMNI_3003`	Workflow not found	Workflow · profile create/list
404	`OMNI_3004`	Analysis not found	Analysis · Report
404	`OMNI_3005`	Profile not found	Profile · Folder · Analysis
404	`OMNI_3006`	Item not found	Item
404	`OMNI_3009`	Folder not found	Folder · Item
400	`OMNI_2106`	Neither `file` nor `content` was provided	Item create
400	`OMNI_2107`	`type` missing when sending `content` only	Item create
409	`OMNI_2005`	Total upload size per profile (100MB) exceeded	Item create
400	`OMNI_2105`	Unsupported file format, or extension and actual content disagree	Item create
400	`OMNI_2205`	`content` of a file item cannot be modified	Item update
400	`OMNI_2206`	The default folder cannot be deleted	Folder delete
400	`OMNI_2109`	Item missing or not part of the profile	Analysis run
409	`OMNI_2201`	An analysis is already running for the profile	Analysis run
400	`OMNI_2208`	Report requested for an analysis that is not complete	Report

Each endpoint page lists only its own error codes and points back here for the common ones.

Pagination

Each list endpoint paginates differently.

Endpoint	Method	Parameters	Next page
Profile list, folder list	Cursor	`cursor`, `limit` (default 10, max 100)	Pass the response’s `nextCursor` as `cursor`. `null` means the end
Analysis list	Last ID	`cursor`, `limit` (default 20, max 50)	Pass the last `items[].id` as `cursor`. `count < limit` means the end
Item list	None	—	No cursor or page size; every item in the folder is returned at once

Sorting is shared: sort and order (asc / desc). The sortable fields are listed on each page.

Limits

Item	Value
Projects per user	5
Workflows per project	10
Items per folder	No limit
Total upload size per profile	100MB
Size of a single file	10 MB
Daily analyses on trial	10
Concurrent analyses per profile	1 (`409` while one is running)

File formats and processing times are listed in Resource limits.

Overview

API Reference

Base URL

Authentication

Resource structure

Response format

Error response format

Common error codes

Per-resource error codes

Limits

​Base URL

​Authentication

​Resource structure

​Response format

​Error response format

​Common error codes

​Per-resource error codes

​Pagination

​Limits

Base URL

Authentication

Resource structure

Response format

Error response format

Common error codes

Per-resource error codes

Pagination

Limits