POST /analyses/:profileId/analyze

Analyses run asynchronously. This endpoint returns only the analysis ID; you poll for the result with get analysis.

Endpoint

POST /v1/analyses/{profileId}/analyze

Request

Path parameters

Parameter	Type	Description
`profileId`	`string`	ID of the profile to analyze (`pf_` prefix)

Request body

Field	Type	Required	Description
`targetItems`	`object[]`	Required	Items to include in the analysis. At least one
`targetItems[].itemId`	`string`	Required	Item ID (`item_` prefix). Must belong to this profile and be `ACTIVE`

curl -X POST "https://client-omni-api.argosidentity.com/v1/analyses/pf_6h4y8s2f0v9n/analyze" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "targetItems": [
      { "itemId": "item_axfkh2noof85" },
      { "itemId": "item_lxzzl2vedy9y" },
      { "itemId": "item_wfepr5xxo6w2" }
    ]
  }'

Response (202 Accepted)

{
  "id": "analysis_lsc7icgm9cjd"
}

Field	Type	Description
`id`	`string`	Analysis ID (`analysis_` prefix)

Conditions and constraints

Item	Detail
Item status	Every target item must be `ACTIVE`. Otherwise `400` `OMNI_2109`
Concurrency	One analysis per profile. Requesting again while one runs returns `409` `OMNI_2201`
Trial limit	10 per day per project. Over that returns `429` `OMNI_2004`
Retention	The 5 most recent analyses per profile. Beyond that, the oldest is deleted automatically

Before you run it, check that isRagReady is true with item status.

Error codes

Status	Code	Description
400	`OMNI_2109`	An item does not exist or does not belong to this profile
404	`OMNI_3005`	Profile not found
409	`OMNI_2201`	An analysis is already running on this profile
429	`OMNI_2004`	Over the daily analysis limit (10) for a trial project

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

Overview

API Reference

POST /analyses/:profileId/analyze

Endpoint

Request

Path parameters

Request body

Response (202 Accepted)

Conditions and constraints

Error codes

​Endpoint

​Request

​Path parameters

​Request body

​Response (202 Accepted)

​Conditions and constraints

​Error codes

Endpoint

Request

Path parameters

Request body

Response (202 Accepted)

Conditions and constraints

Error codes