From 6069f5d82f14423d45976b84c6baa4da4e0ca4a0 Mon Sep 17 00:00:00 2001 From: dhinakaranst Date: Thu, 11 Sep 2025 22:54:34 +0530 Subject: [PATCH 1/2] docs(runs): add description and example to retrieve endpoint (closes #2495) --- docs/management/runs/retrieve.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/management/runs/retrieve.mdx b/docs/management/runs/retrieve.mdx index c6b0e0267d..3c56969c2a 100644 --- a/docs/management/runs/retrieve.mdx +++ b/docs/management/runs/retrieve.mdx @@ -2,3 +2,25 @@ title: "Retrieve run" openapi: "v3-openapi GET /api/v3/runs/{runId}" --- + +Retrieve information about a specific run by `runId`. The response includes status, payload, output, and attempts. + +```ts +import { runs } from "@trigger.dev/sdk"; + +const result = await runs.retrieve("run_1234"); + +if (result.isSuccess) { + console.log("Run was successful with output", result.output); +} + +console.log("Run status:", result.status); +console.log("Payload:", result.payload); +console.log("Output:", result.output); + +for (const attempt of result.attempts) { + if (attempt.status === "FAILED") { + console.log("Attempt failed with error:", attempt.error); + } +} +``` From 61fe900959da1dc795764aff9dc474abf4ad34d2 Mon Sep 17 00:00:00 2001 From: dhinakaranst Date: Thu, 11 Sep 2025 23:17:27 +0530 Subject: [PATCH 2/2] docs(runs): correct retrieve example and add description (closes #2495) --- docs/management/runs/retrieve.mdx | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/management/runs/retrieve.mdx b/docs/management/runs/retrieve.mdx index 3c56969c2a..66a6318fbd 100644 --- a/docs/management/runs/retrieve.mdx +++ b/docs/management/runs/retrieve.mdx @@ -8,19 +8,24 @@ Retrieve information about a specific run by `runId`. The response includes stat ```ts import { runs } from "@trigger.dev/sdk"; -const result = await runs.retrieve("run_1234"); +const runId = "run_1234"; +try { + const run = await runs.retrieve(runId); -if (result.isSuccess) { - console.log("Run was successful with output", result.output); -} + if (run.status === "SUCCESS") { + console.log("Run was successful with output:", run.output); + } -console.log("Run status:", result.status); -console.log("Payload:", result.payload); -console.log("Output:", result.output); + console.log("Run status:", run.status); + console.log("Payload:", run.payload); + console.log("Output:", run.output); -for (const attempt of result.attempts) { - if (attempt.status === "FAILED") { - console.log("Attempt failed with error:", attempt.error); + for (const attempt of run.attempts ?? []) { + if (attempt.status === "FAILED") { + console.log("Attempt failed with error:", attempt.error?.message ?? attempt.error); + } } +} catch (err) { + console.error("Failed to retrieve run", runId, err); } ```