Skip to content
deedglassdocs

timeout

The request ran past its endpoint’s timeout (30 s unless the endpoint says otherwise; 5 s for the system endpoints), and the handler stopped before it wrote a response.

HTTP 504 · api_error · safe to retry

What happened

Section titled “What happened”

The request ran past its endpoint’s timeout (30 s unless the endpoint says otherwise; 5 s for the system endpoints), and the handler stopped before it wrote a response. The work may have partly run.

What to do

Section titled “What to do”

Fetch the object the request was about to see its state (for an action, GET /v1/actions/{id}). If the work didn’t happen, send the request again with a new Idempotency-Key. A 504 on a POST with a key is stored like any other completed response: a retry with the same key replays this 504 for 24 h and doesn’t run the work again.

Example

Section titled “Example”
HTTP 504 · timeout
{
  "error": {
    "type": "api_error",
    "code": "timeout",
    "message": "The request timed out after 30 s. It may have partly run, so fetch the object to see its state before you send it again.",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/timeout"
  }
}

The message is for a person and can get more exact over time: branch on type and code, never on the message.

In the SDKs

Section titled “In the SDKs”
SDK Raised as
TypeScript (@deedglass/sdk) APIError with code === "timeout"
Python (deedglass) deedglass.APIError with .code == "timeout"
Section titled “Related”