from retab import Retab
client = Retab()
page = client.workflows.experiments.runs.list(
experiment_id="exp_abc",
)
for run in page.data:
print(run.id, run.lifecycle.status, run.score)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const page = await client.workflows.experiments.runs.list({
experimentId: "exp_abc",
});
for (const run of page.data) {
console.log(run.id, run.lifecycle.status, run.score);
}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
page, err := client.Workflows.Experiments.Runs.List(ctx, &retab.ExperimentRunsListParams{
ExperimentID: ptr("exp_abc"),
})
if err != nil {
log.Fatal(err)
}
for _, run := range page.Data {
fmt.Println(run.ID, run.Lifecycle.Status(), run.Score)
}
}
use retab::resources::experiment_runs::ListParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let page = client
.workflows().experiments().runs()
.list(ListParams {
experiment_id: Some("exp_abc".into()),
..Default::default()
})
.await?;
for run in &page.data {
println!("{} {:?} {:?}", run.id, run.lifecycle, run.score);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->workflows()->experiments()->runs()->list();
print_r($result);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Workflows.Experiments.Runs.ListAsync(new ExperimentRunsListOptions());
Console.WriteLine(result);
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
result = client.workflows.experiments.runs.list
puts result
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.workflows().experiments().runs().list("wf_abc123", "exp_abc123", "block_abc123", null, null, null, null, null, "created_at", null, null, 10L, null);
System.out.println(result);
}
}
curl -X 'GET' \
'https://api.retab.com/v1/workflows/experiments/runs?experiment_id=exp_abc' \
-H 'Authorization: Bearer <your-api-key>'
{
"data": [
{
"id": "exprun_2",
"workflow": {
"workflow_id": "wf_abc123",
"version_id": "draft_2026_05_18"
},
"trigger": { "type": "api" },
"lifecycle": { "status": "completed" },
"timing": {
"created_at": "2026-05-02T11:00:00Z",
"started_at": "2026-05-02T11:00:01Z",
"completed_at": "2026-05-02T11:04:18Z",
"duration_ms": 258221
},
"experiment_id": "exp_abc",
"block_id": "extract-invoice",
"block_kind": "extract",
"n_consensus": 5,
"total_document_count": 12,
"completed_document_count": 12,
"error_count": 0,
"score": 0.87,
"block_execution_fingerprint": "0ff93ddc7cefcb42",
"documents_fingerprint": "ddd95baadce6045f"
}
],
"list_metadata": {
"before": null,
"after": null
}
}
Runs
List Experiment Runs
List experiment runs.
Optionally filter by workflow_id, experiment_id, block_id,
status/exclude_status, trigger_type, and a from_date/to_date
window. Returns a cursor-paginated list ordered by sort_by (default
newest first).
GET
/
v1
/
workflows
/
experiments
/
runs
from retab import Retab
client = Retab()
page = client.workflows.experiments.runs.list(
experiment_id="exp_abc",
)
for run in page.data:
print(run.id, run.lifecycle.status, run.score)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const page = await client.workflows.experiments.runs.list({
experimentId: "exp_abc",
});
for (const run of page.data) {
console.log(run.id, run.lifecycle.status, run.score);
}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
page, err := client.Workflows.Experiments.Runs.List(ctx, &retab.ExperimentRunsListParams{
ExperimentID: ptr("exp_abc"),
})
if err != nil {
log.Fatal(err)
}
for _, run := range page.Data {
fmt.Println(run.ID, run.Lifecycle.Status(), run.Score)
}
}
use retab::resources::experiment_runs::ListParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let page = client
.workflows().experiments().runs()
.list(ListParams {
experiment_id: Some("exp_abc".into()),
..Default::default()
})
.await?;
for run in &page.data {
println!("{} {:?} {:?}", run.id, run.lifecycle, run.score);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->workflows()->experiments()->runs()->list();
print_r($result);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Workflows.Experiments.Runs.ListAsync(new ExperimentRunsListOptions());
Console.WriteLine(result);
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
result = client.workflows.experiments.runs.list
puts result
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.workflows().experiments().runs().list("wf_abc123", "exp_abc123", "block_abc123", null, null, null, null, null, "created_at", null, null, 10L, null);
System.out.println(result);
}
}
curl -X 'GET' \
'https://api.retab.com/v1/workflows/experiments/runs?experiment_id=exp_abc' \
-H 'Authorization: Bearer <your-api-key>'
{
"data": [
{
"id": "exprun_2",
"workflow": {
"workflow_id": "wf_abc123",
"version_id": "draft_2026_05_18"
},
"trigger": { "type": "api" },
"lifecycle": { "status": "completed" },
"timing": {
"created_at": "2026-05-02T11:00:00Z",
"started_at": "2026-05-02T11:00:01Z",
"completed_at": "2026-05-02T11:04:18Z",
"duration_ms": 258221
},
"experiment_id": "exp_abc",
"block_id": "extract-invoice",
"block_kind": "extract",
"n_consensus": 5,
"total_document_count": 12,
"completed_document_count": 12,
"error_count": 0,
"score": 0.87,
"block_execution_fingerprint": "0ff93ddc7cefcb42",
"documents_fingerprint": "ddd95baadce6045f"
}
],
"list_metadata": {
"before": null,
"after": null
}
}
List experiment runs, newest first. Filter by
workflow_id, experiment_id,
block_id, lifecycle status, trigger type, date range, or id pagination. For
per-document execution data, use List Experiment Run Results;
for consensus scores, use Get Experiment Run Metrics.
The response uses the canonical Retab list envelope:
{ "data": [...], "list_metadata": { "before": null, "after": null } }.
from retab import Retab
client = Retab()
page = client.workflows.experiments.runs.list(
experiment_id="exp_abc",
)
for run in page.data:
print(run.id, run.lifecycle.status, run.score)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const page = await client.workflows.experiments.runs.list({
experimentId: "exp_abc",
});
for (const run of page.data) {
console.log(run.id, run.lifecycle.status, run.score);
}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
page, err := client.Workflows.Experiments.Runs.List(ctx, &retab.ExperimentRunsListParams{
ExperimentID: ptr("exp_abc"),
})
if err != nil {
log.Fatal(err)
}
for _, run := range page.Data {
fmt.Println(run.ID, run.Lifecycle.Status(), run.Score)
}
}
use retab::resources::experiment_runs::ListParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let page = client
.workflows().experiments().runs()
.list(ListParams {
experiment_id: Some("exp_abc".into()),
..Default::default()
})
.await?;
for run in &page.data {
println!("{} {:?} {:?}", run.id, run.lifecycle, run.score);
}
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$result = $client->workflows()->experiments()->runs()->list();
print_r($result);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Workflows.Experiments.Runs.ListAsync(new ExperimentRunsListOptions());
Console.WriteLine(result);
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
result = client.workflows.experiments.runs.list
puts result
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.workflows().experiments().runs().list("wf_abc123", "exp_abc123", "block_abc123", null, null, null, null, null, "created_at", null, null, 10L, null);
System.out.println(result);
}
}
curl -X 'GET' \
'https://api.retab.com/v1/workflows/experiments/runs?experiment_id=exp_abc' \
-H 'Authorization: Bearer <your-api-key>'
{
"data": [
{
"id": "exprun_2",
"workflow": {
"workflow_id": "wf_abc123",
"version_id": "draft_2026_05_18"
},
"trigger": { "type": "api" },
"lifecycle": { "status": "completed" },
"timing": {
"created_at": "2026-05-02T11:00:00Z",
"started_at": "2026-05-02T11:00:01Z",
"completed_at": "2026-05-02T11:04:18Z",
"duration_ms": 258221
},
"experiment_id": "exp_abc",
"block_id": "extract-invoice",
"block_kind": "extract",
"n_consensus": 5,
"total_document_count": 12,
"completed_document_count": 12,
"error_count": 0,
"score": 0.87,
"block_execution_fingerprint": "0ff93ddc7cefcb42",
"documents_fingerprint": "ddd95baadce6045f"
}
],
"list_metadata": {
"before": null,
"after": null
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Available options:
pending, queued, running, completed, error, cancelled Available options:
pending, queued, running, completed, error, cancelled Required range:
1 <= x <= 100Available options:
asc, desc Response
Successful Response
A page of WorkflowExperimentRun resources. data holds the items and list_metadata carries the before/after cursors; pass after to fetch the next page.
⌘I