Errors and retries

Handling errors and retries with the Trigger.dev management API

Handling errors

When the SDK method is unable to connect to the API server, or the API server returns a non-successful response, the SDK will throw an ApiError that you can catch and handle:

import { runs, ApiError } from "@trigger.dev/sdk";

async function main() {
  try {
    const run = await runs.retrieve("run_1234");
  } catch (error) {
    if (error instanceof ApiError) {
      console.error(`API error: ${error.status} ${error.message}`, error.error);
    } else {
      console.error(`Unknown error: ${error.message}`);
    }
  }
}

Retries

The SDK will automatically retry requests that fail due to network errors, 5xx responses, and 408, 409 and 429 responses. By default, the SDK makes up to 5 attempts per request (maxAttempts: 5, so up to 4 retries) with exponential backoff (minTimeoutInMs 1000, maxTimeoutInMs 30000, factor 1.6, randomize false). Any retry fields you pass are merged over these defaults.

You can customize the retry behavior by passing a requestOptions option to the configure function:

import { configure } from "@trigger.dev/sdk";

configure({
  requestOptions: {
    retry: {
      maxAttempts: 5,
      minTimeoutInMs: 1000,
      maxTimeoutInMs: 5000,
      factor: 1.8,
      randomize: true,
    },
  },
});

All SDK functions also take a requestOptions parameter as the last argument, which can be used to customize the request options. You can use this to disable retries for a specific request:

import { runs } from "@trigger.dev/sdk";

async function main() {
  const run = await runs.retrieve("run_1234", {
    retry: {
      maxAttempts: 1, // Disable retries
    },
  });
}