Base URL
/v1.
Authentication
Every request (except/healthz) requires an API key passed in the X-API-Key header.
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your PromptForge API key |
401 Unauthorized.
Error format
All errors return a JSON body with adetail field:
| Status | Meaning |
|---|---|
400 | Bad request — malformed body or missing required fields |
401 | Unauthorized — missing or invalid API key |
404 | Not found — job does not exist or belongs to a different client |
409 | Conflict — job is not in the expected state (e.g. results requested before completion) |
422 | Unprocessable — unsupported provider or model combination |
Health check
{"status": "ok"} when the API is up.
