Return the result of a specific workflow run

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

const options = {method: 'GET'};

fetch('http://localhost:3001/workflow/{id}/runs/{rid}/result', 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}/result",
  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}/result"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

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

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

{
  "v": "2",
  "workflowId": "<string>",
  "runId": "<string>",
  "status": "completed",
  "input": "<unknown>",
  "output": "<unknown>",
  "trace": {
    "local": "<string>",
    "remote": "<string>"
  },
  "error": {
    "activityType": "<string>",
    "name": "<string>",
    "message": "<string>"
  }
}

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

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

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

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

GET

workflow

{id}

runs

{rid}

result

Return the result of a specific workflow run

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

const options = {method: 'GET'};

fetch('http://localhost:3001/workflow/{id}/runs/{rid}/result', 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}/result",
  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}/result"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

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

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

{
  "v": "2",
  "workflowId": "<string>",
  "runId": "<string>",
  "status": "completed",
  "input": "<unknown>",
  "output": "<unknown>",
  "trace": {
    "local": "<string>",
    "remote": "<string>"
  },
  "error": {
    "activityType": "<string>",
    "name": "<string>",
    "message": "<string>"
  }
}

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

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

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

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

Path Parameters

string

required

rid

string<uuid>

required

The specific run id to target

Response

The workflow result

Option 1
Option 2

Current workflow result with direct output and memo-based trace information

enum<string>

required

Workflow result response version

Available options:

2

workflowId

string

required

The workflow execution id

runId

string | null

required

The specific run id for this execution

status

enum<string>

required

The workflow execution status

Available options:

completed,

failed,

cancelled,

terminated,

timed_out,

continued_as_new

input

any | null

required

The original input passed to the workflow, null if unavailable

output

any | null

required

Direct workflow output, null if no output is available

trace

object | null

required

Available destinations for trace data

Show child attributes

error

object · null · null

required

Structured error details captured from the workflow or activity failure

Show child attributes

Start Here

Workflows

Steps

Prompts

Clients

Costs

Evaluators

Production Readiness

Deployment

Integrate with Your App

Packages

Releases

Return the result of a specific workflow run

Path Parameters

Response