> ## 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.

# Descripción general de la API

> Descripción general de la ARGOS Omni API: URL base, autenticación y patrones comunes.

## URL base

```
http://client-omni-api.argosidentity.com/v1
```

<Info>
  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.
</Info>

## Autenticación

Todas las solicitudes requieren el header `x-api-key`:

```bash theme={null}
-H "x-api-key: your-api-key-here"
```

Consulte [Autenticación](/es/omni/getting-started/authentication) 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
```

| Recurso                                         | Endpoints principales                     |
| ----------------------------------------------- | ----------------------------------------- |
| [Project](/es/omni/api-reference/get-project)   | `GET /v1/projects/:projectId`             |
| [Workflow](/es/omni/api-reference/get-workflow) | `GET /v1/workflows/:workflowId`           |
| [Profile](/es/omni/api-reference/post-profile)  | `POST`, `GET`, `PATCH`, `DELETE`          |
| [Folder](/es/omni/api-reference/post-folder)    | `POST`, `GET`, `PATCH`, `DELETE`          |
| [Item](/es/omni/api-reference/post-item)        | `POST` (upload), `GET`, `PATCH`, `DELETE` |

## Formato común de respuesta

Todas las respuestas exitosas siguen este patrón:

```json theme={null}
{
  "success": true,
  "data": { ... }
}
```

## Formato de respuesta de error

```json theme={null}
{
  "error": {
    "code": "ERROR_CODE",
    "status": 400,
    "message": "Human-readable error description"
  }
}
```

### Códigos de error

| Status | Code                | Descripción                                    |
| ------ | ------------------- | ---------------------------------------------- |
| 401    | `UNAUTHORIZED`      | API key inválida o ausente                     |
| 404    | `NOT_FOUND`         | El recurso no existe                           |
| 409    | `CONFLICT`          | Recurso duplicado o límite excedido            |
| 413    | `PAYLOAD_TOO_LARGE` | El tamaño del archivo supera el límite de 10MB |
| 415    | `UNSUPPORTED_MEDIA` | Tipo de archivo no compatible                  |

### Códigos de error específicos por recurso

| Code                    | Descripción                                               |
| ----------------------- | --------------------------------------------------------- |
| `ITEM_LIMIT_EXCEEDED`   | Hay más de 5 items en una sola carpeta                    |
| `FILE_TOO_LARGE`        | El archivo subido supera los 10MB                         |
| `UNSUPPORTED_FILE_TYPE` | El 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**.

```bash theme={null}
GET /v1/workflows/{workflowId}/profiles?page=1&size=50
```