Empezar gratis →

SDK y CLI

Referencia de la API

Cada ruta que llama una aplicación, un agente o un proveedor de identidad: cómo se autentica, el ámbito que necesita una clave, los campos que recibe y las respuestas que da.

El archivo OpenAPI

La misma referencia como archivo OpenAPI 3.1, para generadores de código y pruebas de contrato. Se construye a partir del contrato que las pruebas de Azoth contrastan con las rutas en ambos sentidos: una ruta que falte en él, o una que nombre y no exista, las hace fallar.

openapi.yaml

Los resúmenes de las rutas y los nombres de los campos están en inglés, aquí y en el archivo.

Autenticación

Authorization
Bearer <key>: una clave API del espacio de trabajo, de Ajustes › Acceso — az_live_…, o az_test_… en el plan gratuito. Una clave con ámbitos solo alcanza las rutas que cubren sus ámbitos.
X-Azoth-API-Key
<key>: la misma clave en su propia cabecera. Cada ruta que acepta una clave acepta las dos.

Las lecturas propias del panel — /api/v1/me y las lecturas de GreenOps — requieren una sesión iniciada, nunca una clave. Las rutas SCIM requieren el token SCIM del espacio de trabajo (aprovisionamiento SCIM).

Respuestas y errores

Una respuesta de error lleva error, una frase, un code estable y un doc_url que lleva a la entrada del código en Códigos de error; un 400 nombra además el field que falló. Un límite de frecuencia responde 429 con retryAfterMs en el cuerpo y Retry-After en las cabeceras. Una ruta cuyo módulo no ejecuta el despliegue lo indica. Una llamada a la pasarela que no es en streaming (/api/v1/chat/completions, /api/v1/chat) se puede reintentar sin riesgo con una cabecera Idempotency-Key: dentro de la hora, un reintento de una llamada ya respondida recibe esa primera respuesta — nunca una segunda llamada al modelo, un segundo sellado ni un segundo gasto — cuando la política de datos del espacio de trabajo permite a Azoth conservarla; si no, el reintento lo indica (idempotency_replay_unavailable), con la traza de la primera llamada.

Rutas

Una página por parte de la API, con cada una de sus rutas completa: cómo se autentica, el ámbito que necesita una clave, sus parámetros y los campos de su cuerpo, sus respuestas y sus códigos. Abajo, cada parte con sus rutas, una línea cada una, enlazada a su entrada completa. El archivo contiene el tipo y los límites de cada campo, y el cuerpo de cada respuesta.

Llamadas a la pasarela

Llamar a un modelo a través de la pasarela gobernada — y en torno a una llamada: si necesita un modelo, el modelo que puede usar una primera llamada, reanudar una llamada retenida, pedir una excepción, la comprobación de anclaje y los recibos de tu propia bóveda.

Todas las rutas de esta parte, completas

/api/v1/chat

/api/v1/infer

/api/v1/models

/api/v1/exceptions

/api/v1/grounding

/api/v1/vault

Telemetría y optimización

Informar de las llamadas hechas fuera de la pasarela, elegir un modelo para una solicitud, buscar y guardar respuestas en caché, comprobar si un agente entra en bucle, comprimir contenido largo y consultar el mercado de proveedores.

Todas las rutas de esta parte, completas

/api/ingest

/api/arbiter

/api/cache

/api/loops

/api/v1/compress

/api/v1/reconstruct

/api/v1/marketplace

Prueba

Leer las decisiones selladas, exportar el expediente de auditoría o el de una decisión, obtener las claves públicas que verifican los recibos, y leer las pruebas de Azoth Guard y los incidentes del espacio de trabajo.

Todas las rutas de esta parte, completas

/api/v1/journal

/api/v1/decisions

/api/proof

/api/v1/guard

/api/v1/incidents

Sistemas y políticas

Declarar tus sistemas (casos de uso) y leerlos, con las llamadas que salieron de aquello para lo que uno fue aprobado; leer los paquetes regulatorios y la política de datos que aplica el SDK.

Todas las rutas de esta parte, completas

/api/v1/usecases

/api/v1/policy

/api/v1/governance

Pruebas y cambios de modelo

Gestionar las suites de regresión y ejecutarlas, o comparar modelos en una; leer las ejecuciones de conjuntos de referencia que esperan a tu sistema cuando cambia un modelo, y enviar sus resultados.

Todas las rutas de esta parte, completas

/api/v1/regression

/api/v1/reference-sets

Agentes y MCP

Leer el gasto y el ahorro por agente, llamar a herramientas a través de la pasarela MCP gobernada y ejecutar las herramientas de lectura del asistente.

Todas las rutas de esta parte, completas

/api/v1/agents

/api/v1/mcp

/api/v1/insights

Uso, gasto y huella

Leer las trazas de uso, el informe de gasto y ahorro, los presupuestos y su consumo, y la huella estimada de energía y de carbono.

Todas las rutas de esta parte, completas

/api/v1/usage

/api/v1/report

/api/v1/budgets

/api/v1/greenops

Servicio y cuenta

Comprobar que el servicio responde, ver qué módulos están listos para producción, exportar los datos del espacio de trabajo y leer o borrar tu propia cuenta.

Todas las rutas de esta parte, completas

/api/health

/api/v1/system

/api/v1/export

/api/v1/me

  • GET /api/v1/me — Your personal data (GDPR art. 15) — signed in, never an API key
  • DELETE /api/v1/me — Erase your account (GDPR art. 17) — signed in, never an API key

Aprovisionamiento SCIM

Crear, actualizar y retirar usuarios y grupos desde tu proveedor de identidad, con el token SCIM del espacio de trabajo.

Todas las rutas de esta parte, completas

/api/scim/v2