Replay run

POST

api

runs

{runId}

replay

TypeScript

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

const handle = await runs.replay("run_1234");

const withOverrides = await runs.replay("run_1234", {
  payload: { userId: "user_456" },
  tags: ["replayed"],
  delay: "10m",
});

curl --request POST \
  --url https://api.trigger.dev/api/v1/runs/{runId}/replay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "userId": "user_456"
  },
  "tags": [
    "replayed"
  ],
  "delay": "10m"
}
'

import requests

url = "https://api.trigger.dev/api/v1/runs/{runId}/replay"

payload = {
    "payload": { "userId": "user_456" },
    "tags": ["replayed"],
    "delay": "10m"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({payload: {userId: 'user_456'}, tags: ['replayed'], delay: '10m'})
};

fetch('https://api.trigger.dev/api/v1/runs/{runId}/replay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trigger.dev/api/v1/runs/{runId}/replay",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payload' => [
        'userId' => 'user_456'
    ],
    'tags' => [
        'replayed'
    ],
    'delay' => '10m'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trigger.dev/api/v1/runs/{runId}/replay"

	payload := strings.NewReader("{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trigger.dev/api/v1/runs/{runId}/replay")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/runs/{runId}/replay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Invalid or Missing API key"
}

{
  "error": "<string>"
}

{
  "error": "Run not found"
}

Authorizations

Authorization

string

header

required

Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.

Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

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

configure({ accessToken: "tr_dev_sk_1234" });

Path Parameters

runId

string

required

The ID of an run, starts with run_. The run ID will be returned when you trigger a run on a task.

Body

application/json

payload

any

The payload for the new run. Omit it to reuse the original run's payload.

payloadType

enum<string>

How payload is encoded. Defaults to application/json. With application/super+json, payload must be a SuperJSON string, which keeps types like Date and BigInt. The SDK sends this automatically.

Available options:

application/json,

application/super+json

metadata

object

Metadata for the new run. Omit it to reuse the original run's metadata.

Response

Successful request

string

The ID of the new run.

⌘I

TypeScript

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

const handle = await runs.replay("run_1234");

const withOverrides = await runs.replay("run_1234", {
  payload: { userId: "user_456" },
  tags: ["replayed"],
  delay: "10m",
});

curl --request POST \
  --url https://api.trigger.dev/api/v1/runs/{runId}/replay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "userId": "user_456"
  },
  "tags": [
    "replayed"
  ],
  "delay": "10m"
}
'

import requests

url = "https://api.trigger.dev/api/v1/runs/{runId}/replay"

payload = {
    "payload": { "userId": "user_456" },
    "tags": ["replayed"],
    "delay": "10m"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({payload: {userId: 'user_456'}, tags: ['replayed'], delay: '10m'})
};

fetch('https://api.trigger.dev/api/v1/runs/{runId}/replay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trigger.dev/api/v1/runs/{runId}/replay",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payload' => [
        'userId' => 'user_456'
    ],
    'tags' => [
        'replayed'
    ],
    'delay' => '10m'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trigger.dev/api/v1/runs/{runId}/replay"

	payload := strings.NewReader("{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trigger.dev/api/v1/runs/{runId}/replay")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/runs/{runId}/replay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": {\n    \"userId\": \"user_456\"\n  },\n  \"tags\": [\n    \"replayed\"\n  ],\n  \"delay\": \"10m\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Invalid or Missing API key"
}

{
  "error": "<string>"
}

{
  "error": "Run not found"
}

API reference

Tasks API

Batches API

Runs API

Bulk actions API

Errors API

Queues API

Concurrency limits API

Schedules API

Env Vars API

Deployments API

Waitpoints API

Sessions API

Query API

Authorizations

Path Parameters

Body

Response