ai
POST /v1/ai/credentials/{credentialId}/test
Test a stored AI provider key now.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.payment.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/ai/credentials/{credentialId}/test \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Runs a **real, tiny completion with our own prompts and tool format** on the key — not the free authentication probe. ⚖️ The owner's requirement, verbatim: *"it must test it works with our system and prompts."* Authenticating and *working with our prompts* are different claims, and a screen showing only the first as a green tick is a control that cannot see the failure it exists to catch. Costs a fraction of a cent on the customer's own key, which is why it is only ever run on save, weekly, or when a person presses the button. Requires `billing.payment.manage`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
credentialId (path) | Uuid | Sí | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
ok | boolean | Sí | — |
exercised_prompt | boolean | Sí | ⭐ Whether a **real call with our own prompts** was made. `false` means we proved only that the key authenticates — a narrower claim a screen showing just "working" would erase,… |
detail | string | No | — |
model | string | No | — |
latency_ms | integer | No | — |
state | string<untested, working, broken> | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429