Descripción general de la API

La API de Omni conecta las revisiones de su Review Ops Agent con sus sistemas existentes. Usted envía el sujeto y sus documentos, y recibe la decisión, los datos y los fundamentos armados según su output schema.

Base URL

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

Si su tráfico saliente está restringido por un firewall o un proxy, permita HTTPS (443) hacia client-omni-api.argosidentity.com.

Autenticación

Cada petición lleva la API key del proyecto en la cabecera x-api-key. La key se emite al crear el proyecto y puede regenerarse — consulte Autenticación.

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

Las keys están limitadas a un único proyecto. Pedir un recurso de otro proyecto devuelve 403 OMNI_5001.

Estructura de recursos

Project → Workflow → Profile → Folder → Item → Analysis

Recurso	Endpoint	Notas
Project	`GET /projects/:projectId`	Solo lectura. Se crea y configura en el panel
Workflow	`GET /workflows/:workflowId`, `GET /workflows/:workflowId/summary`	Solo lectura. Se crea y edita en el panel
Profile	`POST` · `GET` · `PATCH` · `DELETE`	Vive bajo un workflow
Folder	`POST` · `GET` · `PATCH` · `DELETE`	Cada perfil se crea con una carpeta por defecto
Item	`POST` · `GET` · `PATCH` · `DELETE`	Subida de archivo, o contenido de texto y JSON
Analysis	`POST` · `GET lista` · `GET detalle` · `DELETE` · `GET informe`	Se ejecuta de forma asíncrona

Formato de respuesta

Las respuestas de lectura devuelven el objeto del recurso directamente, sin campo envolvente. Las respuestas de lista llevan count e items, y algunas añaden nextCursor.

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

Todas las marcas de tiempo son ISO 8601 UTC (2026-09-10T04:23:56.000Z). Los borrados devuelven 204 No Content.

Formato de respuesta de error

Los cuerpos de error colocan code y message en el nivel superior. Bifurque su lógica con code; trate message únicamente como texto para mostrar.

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

Campo	Tipo	Descripción
`code`	`string`	Código de error con el prefijo `OMNI_`
`message`	`string`	Explicación legible. La redacción puede cambiar. Fijo en `Internal server error` para los errores de la clase 500
`details`	`object \| array`	(opcional) Información adicional, presente solo en fallos de validación de la petición y casos similares

Códigos de error comunes

Estado	Código	Descripción
400	`OMNI_2101`	El cuerpo, la query o el archivo subido no pasaron la validación. La infracción concreta está en `message`
401	`OMNI_4001`	Falta la cabecera `x-api-key`
401	`OMNI_4005`	API key inválida o revocada
403	`OMNI_5001`	El recurso no pertenece al proyecto de la key
404	`OMNI_30xx`	Recurso no encontrado. Vea la tabla por recurso más abajo
429	`OMNI_2004`	Superado el límite diario de análisis de los proyectos de prueba (10)
500	`OMNI_6001`	Error interno del servidor. Reintente en breve; contacte con soporte si persiste

Códigos de error por recurso

Estado	Código	Descripción	Dónde
404	`OMNI_3002`	Proyecto no encontrado	Project
404	`OMNI_3003`	Workflow no encontrado	Workflow · crear/listar perfiles
404	`OMNI_3004`	Análisis no encontrado	Analysis · Report
404	`OMNI_3005`	Perfil no encontrado	Profile · Folder · Analysis
404	`OMNI_3006`	Ítem no encontrado	Item
404	`OMNI_3009`	Carpeta no encontrada	Folder · Item
400	`OMNI_2106`	No se envió ni `file` ni `content`	Crear ítem
400	`OMNI_2107`	Falta `type` al enviar solo `content`	Crear ítem
409	`OMNI_2005`	Superado el tamaño total subido por perfil (100MB)	Crear ítem
400	`OMNI_2105`	Formato de archivo no admitido, o la extensión no concuerda con el contenido real	Crear ítem
400	`OMNI_2205`	El `content` de un ítem de tipo archivo no se puede modificar	Actualizar ítem
400	`OMNI_2206`	La carpeta por defecto no se puede eliminar	Eliminar carpeta
400	`OMNI_2109`	Ítem inexistente o que no pertenece al perfil	Ejecutar análisis
409	`OMNI_2201`	Ya hay un análisis en curso para ese perfil	Ejecutar análisis
400	`OMNI_2208`	Informe solicitado para un análisis que no está completo	Report

Cada página de endpoint lista solo sus propios códigos de error y remite aquí para los comunes.

Paginación

Cada endpoint de lista pagina de una forma distinta.

Endpoint	Método	Parámetros	Página siguiente
Lista de perfiles, lista de carpetas	Cursor	`cursor`, `limit` (por defecto 10, máx. 100)	Pase el `nextCursor` de la respuesta como `cursor`. `null` significa el final
Lista de análisis	Último ID	`cursor`, `limit` (por defecto 20, máx. 50)	Pase el último `items[].id` como `cursor`. `count < limit` significa el final
Lista de ítems	Ninguno	—	Sin cursor ni tamaño de página; se devuelven de una vez todos los ítems de la carpeta

La ordenación es común: sort y order (asc / desc). Los campos ordenables se indican en cada página.

Límites

Elemento	Valor
Proyectos por usuario	5
Workflows por proyecto	10
Ítems por carpeta	Sin límite
Tamaño total subido por perfil	100MB
Tamaño de un archivo	10 MB
Análisis diarios en prueba	10
Análisis simultáneos por perfil	1 (`409` mientras haya uno en curso)

Los formatos de archivo y los tiempos de procesamiento están en Límites de recursos.