| Propósito | Endpoint |
|---|---|
| Perfiles de un workflow | GET /v1/workflows/{workflowId}/profiles |
| Un perfil concreto | GET /v1/profiles/{profileId} |
| Estado de procesamiento de los ítems | GET /v1/profiles/{profileId}/items/status |
Listar perfiles
GET /v1/workflows/{workflowId}/profiles
Parámetros de consulta
| Parámetro | Tipo | Por defecto | Descripción |
|---|---|---|---|
search | string | Coincidencia parcial con el nombre del perfil | |
sort | string | createdAt | name · createdAt · lastAnalysisAt |
order | string | desc | asc · desc |
cursor | string | El nextCursor de la respuesta anterior | |
limit | number | 10 | Elementos por página (máx. 100) |
curl "https://client-omni-api.argosidentity.com/v1/workflows/wf_3p8k2m5r9v1t/profiles?sort=createdAt&order=desc&limit=20" \
-H "x-api-key: your-api-key-here"
Respuesta
{
"count": 1,
"nextCursor": null,
"items": [
{
"id": "pf_6h4y8s2f0v9n",
"workflowId": "wf_3p8k2m5r9v1t",
"name": "example",
"description": "Example profile for document verification",
"metadata": { "vendor_id": "VND-2026-0142" },
"itemsCount": 3,
"foldersCount": 1,
"lastAnalysisAt": "2026-09-10T05:41:09.220Z",
"createdAt": "2026-09-10T05:32:47.118Z",
"updatedAt": "2026-09-10T05:41:09.220Z"
}
]
}
| Campo | Tipo | Descripción |
|---|---|---|
count | number | Número de elementos en esta respuesta |
nextCursor | string | null | Cursor de la página siguiente. null en la última página |
items[].id | string | ID del perfil (prefijo pf_) |
items[].workflowId | string | ID del workflow padre |
items[].name | string | Nombre del perfil |
items[].description | string | null | Descripción |
items[].metadata | object | null | Metadatos propios |
items[].itemsCount | number | Total de ítems en todas las carpetas |
items[].foldersCount | number | Número de carpetas |
items[].lastAnalysisAt | string | null | Fecha del último análisis. null si no hay historial |
items[].createdAt | string | Fecha de creación |
items[].updatedAt | string | Fecha de última modificación |
Leer un perfil
GET /v1/profiles/{profileId}
curl "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n" \
-H "x-api-key: your-api-key-here"
Respuesta
A diferencia de una entrada de lista, esta respuesta lleva un arrayfolders en lugar de foldersCount.
{
"id": "pf_6h4y8s2f0v9n",
"workflowId": "wf_3p8k2m5r9v1t",
"name": "example",
"description": "Example profile for document verification",
"metadata": { "vendor_id": "VND-2026-0142" },
"itemsCount": 3,
"lastAnalysisAt": "2026-09-10T05:41:09.220Z",
"folders": [
{
"id": "fd_9pq2mklt83bx",
"name": "default",
"isDefault": true,
"itemsCount": 3,
"createdAt": "2026-09-10T05:32:47.118Z"
}
],
"recentAnalyses": [
{
"id": "analysis_lsc7icgm9cjd",
"status": "completed",
"verificationStatus": "verified",
"createdAt": "2026-09-10T05:41:09.220Z"
}
],
"createdAt": "2026-09-10T05:32:47.118Z",
"updatedAt": "2026-09-10T05:41:09.220Z"
}
| Campo | Tipo | Descripción |
|---|---|---|
folders[].id | string | ID de la carpeta (prefijo fd_) |
folders[].name | string | Nombre de la carpeta |
folders[].isDefault | boolean | Si es la carpeta por defecto creada con el perfil |
folders[].itemsCount | number | Número de ítems de la carpeta |
folders[].createdAt | string | Fecha de creación |
recentAnalyses | object[] | Análisis más recientes (hasta 5). Array vacío si no hay ninguno |
recentAnalyses[].id | string | ID del análisis (prefijo analysis_) |
recentAnalyses[].status | string | pending · processing · completed · failed |
recentAnalyses[].verificationStatus | string | null | verified · pending_review · rejected. null si está incompleto o falló |
recentAnalyses[].createdAt | string | Fecha de creación del análisis |
Estado de los ítems
GET /v1/profiles/{profileId}/items/status
curl "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n/items/status" \
-H "x-api-key: your-api-key-here"
Respuesta
{
"profileId": "pf_6h4y8s2f0v9n",
"isRagReady": true,
"summary": { "total": 3, "pending": 0, "active": 3, "failed": 0 },
"items": [
{
"id": "item_axfkh2noof85",
"name": "certificate of good standing",
"type": "text",
"status": "ACTIVE",
"processedAt": "2026-09-10T05:35:38.902Z"
}
]
}
| Campo | Tipo | Descripción |
|---|---|---|
profileId | string | ID del perfil |
isRagReady | boolean | true cuando todos los ítems están ACTIVE. Indica si se puede ejecutar un análisis |
summary.total | number | Total de ítems |
summary.pending | number | Ítems en PENDING |
summary.active | number | Ítems en ACTIVE |
summary.failed | number | Ítems en FAILED |
items[].id | string | ID del ítem |
items[].name | string | Nombre del ítem |
items[].type | string | file · text · json |
items[].status | string | PENDING · ACTIVE · FAILED |
items[].processedAt | string | null | Fin del procesamiento. null mientras está PENDING |
Tras añadir ítems, sondee este endpoint una vez por segundo y ejecute el análisis cuando
isRagReady pase a true. Si summary.failed no es 0, elimine el ítem afectado y vuelva a añadirlo.Códigos de error
| Estado | Código | Descripción |
|---|---|---|
| 404 | OMNI_3003 | Workflow no encontrado (lista) |
| 404 | OMNI_3005 | Perfil no encontrado (perfil concreto, estado de los ítems) |