Saltar al contenido principal

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.

​
URL base

http://client-omni-api.argosidentity.com/v1
Si su organización restringe el tráfico saliente mediante firewall o proxy, añada client-omni-api.argosidentity.com a su lista de permitidos para HTTP (puerto 80). Añada también el puerto 443 si usa HTTPS.

​
Autenticación

Todas las solicitudes requieren el header x-api-key: 
-H "x-api-key: your-api-key-here"
Consulte Autenticación para ver cómo obtener su API key.

​
Estructura de la API

La Omni API sigue la siguiente jerarquía de datos: 
Project → Workflow → Profile → Folder → Item → Analysis
RecursoEndpoints principales
ProjectGET /v1/projects/:projectId
WorkflowGET /v1/workflows/:workflowId
ProfilePOST, GET, PATCH, DELETE
FolderPOST, GET, PATCH, DELETE
ItemPOST (upload), GET, PATCH, DELETE

​
Formato común de respuesta

Todas las respuestas exitosas siguen este patrón: 
{
  "success": true,
  "data": { ... }
}

​
Formato de respuesta de error

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

​
Códigos de error

StatusCodeDescripción
401UNAUTHORIZEDAPI key inválida o ausente
404NOT_FOUNDEl recurso no existe
409CONFLICTRecurso duplicado o límite excedido
413PAYLOAD_TOO_LARGEEl tamaño del archivo supera el límite de 10MB
415UNSUPPORTED_MEDIATipo de archivo no compatible

​
Códigos de error específicos por recurso

CodeDescripción
ITEM_LIMIT_EXCEEDEDHay más de 5 items en una sola carpeta
FILE_TOO_LARGEEl archivo subido supera los 10MB
UNSUPPORTED_FILE_TYPEEl formato del archivo no está en la lista de compatibles

​
Paginación

Los endpoints de lista devuelven resultados paginados con un tamaño de página predeterminado de 50 items. 
GET /v1/workflows/{workflowId}/profiles?page=1&size=50