Skip to main content
Aquila returns errors as JSON with a stable shape:
  • error — a short human-readable message.
  • details — optional. Present on request validation failures. The shape mirrors the failing fields.

Status codes

Async operations

Scan starts, bulk deletions, and report generation return 202. The response names the job or resource. Poll the matching GET endpoint, or watch the dashboard, until the work completes.

Streaming responses

The AI generation endpoints stream NDJSON frames instead of one JSON body. Each line is a frame of type chunk, final, or error. Read the line until the stream closes. Three of these endpoints speak WebSocket instead. The endpoint descriptions in the API reference mark them.