Skip to main content

Base URL

Authentication

All API requests require an API key in the X-API-Key header:
Get your API key from the welcome email sent when you first sign in at zenveil.dev. Lost it? Go to Dashboard → Settings → Rotate Key.

Endpoints

Streaming responses

AI endpoints (/v1/explain, /v1/fix, /v1/triage) return text/plain streaming responses. Read the response incrementally:

Error handling

Error response format

Streaming error sentinel

AI streaming responses may include an error sentinel if the AI provider fails mid-stream:
Check for [ZENVEIL_ERROR] prefix in streaming chunks and surface the message to the user.

Rate limits

Rate limits are per API key. Billing API calls are additionally limited to 10 requests/hour per key to prevent abuse.

Interactive API explorer

The scanning API has built-in Swagger UI and ReDoc documentation:
  • Swagger UI: https://api.zenveil.dev/docs
  • ReDoc: https://api.zenveil.dev/redoc

Health check