Service unavailable

HTTP 503, unavailable. The API cannot answer right now. The condition is temporary.

Type	https://docs.pinakelai.com/errors/unavailable
Status	503
Retry	Yes, after Retry-After.

​

When it happens

• The service is busy: every database connection is in use, or the request waited too long for one.
• A database statement outside search timed out, or the database is under memory pressure.
• The database could not be reached.
• On retrieve: the record exists but cannot be assembled at the moment, for example while its source document is being replaced.

Retry-After is usually a few seconds, and longer under memory pressure.

​

What to do

Retry after Retry-After seconds, with exponential backoff if it repeats. GET /v1/health shows whether the API can reach its data stores.

​

Example

Headers

HTTP/1.1 503 Service Unavailable
Content-Type: application/problem+json
Retry-After: 5

Body

{
  "type": "https://docs.pinakelai.com/errors/unavailable",
  "title": "Service unavailable",
  "status": 503,
  "detail": "The service is busy. Retry shortly.",
  "request_id": "req_01M7Q40VWXYZ0123456789ABCD"
}

See the errors catalogue for every error type, and Handling errors for retry strategy.