Errors

Every error code the API returns, what it means and whether to retry.

Errors are JSON with the HTTP status and a stable code:

{ "error": { "code": "TIMEOUT", "message": "The page took too long to load" } }

Switch on code, not on message: the code is the stable part. Failed requests don't count toward your quota.

Codes#

Retrying#

Retry 429, 503 and 504 QUEUE_TIMEOUT with a growing wait, for example 1, 2 and 4 seconds. Don't retry 4xx errors other than 429 without changing the request. The SDKs do this for you.

async function render(body, attempt = 0) {
  const res = await fetch('https://rendersbolt.com/v1/pdf', {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
    body: JSON.stringify(body),
  });
  if (res.ok) return Buffer.from(await res.arrayBuffer());
  const { error } = await res.json();
  const retry = res.status === 429 || res.status === 503 || error.code === 'QUEUE_TIMEOUT';
  if (retry && attempt < 3) {
    const wait = Number(res.headers.get('retry-after')) * 1000 || 1000 * 2 ** attempt;
    await new Promise((r) => setTimeout(r, wait));
    return render(body, attempt + 1);
  }
  throw new Error(`${error.code}: ${error.message}`);
}

Stuck? Write to [email protected] with the request you sent and the error code you got back.