Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/ai/credentials/{credentialId}/test \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
credentialId (path) | Uuid | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
ok | boolean | Yes | — |
exercised_prompt | boolean | Yes | ⭐ 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> | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429