| title | sidebarTitle | description |
|---|---|---|
Errors and retries |
Errors and retries |
Handling errors and retries with the Trigger.dev management API |
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/v3";
async function main() {
try {
const run = await runs.retrieve("run_1234");
} catch (error) {
if (error instanceof ApiError) {
console.error(`API error: ${error.status}, ${error.headers}, ${error.body}`);
} else {
console.error(`Unknown error: ${error.message}`);
}
}
}The SDK will automatically retry requests that fail due to network errors or server errors. By default, the SDK will retry requests up to 3 times, with an exponential backoff delay between retries.
You can customize the retry behavior by passing a requestOptions option to the configure function:
import { configure } from "@trigger.dev/sdk/v3";
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/v3";
async function main() {
const run = await runs.retrieve("run_1234", {
retry: {
maxAttempts: 1, // Disable retries
},
});
}