Skip to main content

​
Base URL

https://api.zenveil.dev

​
Authentication

All API requests require an API key in the X-API-Key header: 
curl https://api.zenveil.dev/v1/scan/github \
  -H "X-API-Key: zvk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"repository": "owner/repo"}'
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

MethodEndpointDescription
GET/healthHealth check
POST/v1/scan/githubScan a GitHub repository
POST/v1/scan/apiScan an API endpoint
POST/v1/explainAI explanation of a finding (streaming)
POST/v1/fixAI-generated fix for a finding (streaming)
POST/v1/fix/prOpen a GitHub PR with a deterministic fix
POST/v1/triageAI-generated triage plan for all findings (streaming)

​
Streaming responses

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

with httpx.stream("POST", "https://api.zenveil.dev/v1/explain",
    headers={"X-API-Key": "zvk_live_your_key"},
    json={"finding": {...}}
) as response:
    for chunk in response.iter_text():
        print(chunk, end="", flush=True)

const response = await fetch('https://api.zenveil.dev/v1/explain', {
  method: 'POST',
  headers: {
    'X-API-Key': 'zvk_live_your_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ finding: { ... } }),
});

const reader = response.body.getReader();
const decoder = new TextDecoder();
while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  process.stdout.write(decoder.decode(value));
}

​
Error handling

StatusMeaning
200Success
400Bad request — invalid input, missing required fields
401Unauthorized — missing or invalid API key
403Forbidden — token lacks required permissions
404Not found — repository doesn’t exist or isn’t accessible
429Rate limited — slow down requests
500Internal error — scan failed unexpectedly
503AI unavailable — Anthropic API is at capacity

​
Error response format

{
  "detail": "Repository not found. Check the name and try again."
}

​
Streaming error sentinel

AI streaming responses may include an error sentinel if the AI provider fails mid-stream: 
[ZENVEIL_ERROR]Our AI engine is currently at capacity. Please wait a moment and try again.
Check for [ZENVEIL_ERROR] prefix in streaming chunks and surface the message to the user.

​
Rate limits

PlanScans/hourAI requests/hour
Free105
Pro10050
TeamUnlimited200
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

curl https://api.zenveil.dev/health

{
  "status": "ok",
  "version": "1.0.0"
}