Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/management/runs/retrieve.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,30 @@
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 runId = "run_1234";
try {
const run = await runs.retrieve(runId);

if (run.status === "SUCCESS") {
console.log("Run was successful with output:", run.output);
}

console.log("Run status:", run.status);
console.log("Payload:", run.payload);
console.log("Output:", run.output);

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);
}
```