Get paginated workflow execution history for a specific run

GET /workflow/{id}/runs/{rid}/history

Get paginated workflow execution history for a specific run

cURL

curl --request GET \
  --url http://localhost:3001/workflow/{id}/runs/{rid}/history

import requests

url = "http://localhost:3001/workflow/{id}/runs/{rid}/history"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('http://localhost:3001/workflow/{id}/runs/{rid}/history', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/workflow/{id}/runs/{rid}/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:3001/workflow/{id}/runs/{rid}/history"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:3001/workflow/{id}/runs/{rid}/history")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/workflow/{id}/runs/{rid}/history")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "workflow": {},
  "events": [
    {}
  ],
  "runId": "<string>",
  "nextPageToken": "<string>"
}

{
  "error": "ValidationError",
  "message": "Invalid Payload",
  "issues": [
    {}
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "workflowId": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "workflowId": "<string>"
}

Path Parameters

id · string · required

The workflow execution ID

rid · string<uuid> · required

The specific run id to target

Query Parameters

pageSize · integer · default: 20

Number of events per page

Required range: 1 <= x <= 50

pageToken · string

Base64 pagination token from previous response

includePayloads · boolean · default: false

Include decoded input/output payloads in events

Response

200

application/json

Paginated history events

workflow · object | null

Workflow metadata (null on subsequent pages)

events · object[]

runId · string

The pinned run ID

nextPageToken · string | null