API conventions
Quake AI exposes upstream OpenStack APIs for compute, networking, block storage, images, Kubernetes, automation, and identity, plus an S3-compatible interface for Object Storage. Conventions like error response shape, request correlation headers, and retry semantics are consistent across these APIs and apply equally to each published service.
This section is the cross-service reference for those conventions. Service-specific error catalogs (state machines, common fault messages, per-resource error codes) live under each service's own reference/ subsection.
Pages in this section#
- Error response format: OpenStack JSON error structure, the Compute fault object, S3 XML errors, and request correlation fields you should collect for support tickets. Includes parsing examples in
curl+jqand Python. - Retry and resilience patterns: error classification (4xx vs 5xx vs 409 state-conflict), the authoritative status-code retry map, exponential backoff with jitter (Bash and Python implementations), and idempotency guidance for create/update/delete operations.
When to use this section#
Use these pages when you are:
- Building a client, SDK wrapper, or automation script that calls Quake AI APIs and needs to handle errors uniformly across services
- Writing a Terraform/OpenTofu provider configuration or post-apply check that needs to interpret API errors
- Diagnosing an unfamiliar error response and want to know whether to retry, fix the request, or escalate
- Collecting evidence for a support ticket and need to know which correlation headers and IDs to capture
For service-specific error meanings (e.g., what a 409 on a volume operation actually means, or what the task_state field can be on a Compute server), see the per-service API error references: