Skip to main content

Base URL

https://api.promptforge.dev
All endpoints are versioned under /v1.

Authentication

Every request (except /healthz) requires an API key passed in the X-API-Key header.
curl https://api.promptforge.dev/v1/jobs/init \
  -H "X-API-Key: your-api-key"
HeaderRequiredDescription
X-API-KeyYesYour PromptForge API key
Missing or invalid keys return 401 Unauthorized.

Error format

All errors return a JSON body with a detail field:
{
  "detail": "Invalid API key"
}
StatusMeaning
400Bad request — malformed body or missing required fields
401Unauthorized — missing or invalid API key
404Not found — job does not exist or belongs to a different client
409Conflict — job is not in the expected state (e.g. results requested before completion)
422Unprocessable — unsupported provider or model combination

Health check

GET /healthz
No authentication required. Returns {"status": "ok"} when the API is up.