> ## Documentation Index
> Fetch the complete documentation index at: https://docs.retab.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Eval Results
> List workflow eval results for a single run, page by page.
Results are returned in run-time order.
List the eval results produced by one workflow-eval run. Filter by `run_id`;
each result also has
its own opaque `id`; use [Get Workflow Eval Result](/api-reference/workflows/evals/results/get)
to refresh one row directly.
The response uses the canonical Retab list envelope:
`{ "data": [...], "list_metadata": { "before": null, "after": null } }`.
```python Python theme={null}
from retab import Retab
client = Retab()
results = client.workflows.evals.results.list("wfevalrun_q1z2")
for result in results.data:
print(result.eval_id, result.verdict)
```
```typescript TypeScript theme={null}
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const results = await client.workflows.evals.results.list({
runId: "wfevalrun_q1z2",
});
for (const result of results.data) {
console.log(result.evalId, result.verdict);
}
```
```go Go theme={null}
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)
}
results, err := client.Workflows.Evals.Results.List(ctx, &retab.WorkflowEvalRunResultsListParams{
RunID: "wfevalrun_q1z2",
})
if err != nil {
log.Fatal(err)
}
for _, result := range results.Data {
fmt.Println(result.EvalID, result.Verdict)
}
}
```
```ruby Ruby theme={null}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
results = client.workflows.evals.results.list(run_id: 'wfevalrun_q1z2')
results.data.each do |result|
puts "#{result.eval_id} #{result.verdict}"
end
```
```rust Rust theme={null}
use retab::resources::workflow_eval_run_results::ListParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let results = client
.workflows().evals().results()
.list(ListParams::new("wfevalrun_q1z2"))
.await?;
for result in &results.data {
println!("{} {:?}", result.eval_id, result.verdict);
}
Ok(())
}
```
```php PHP theme={null}
workflows()->evals()->results()->list(
runId: 'run_abc123',
);
print_r($result);
```
```csharp C# theme={null}
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Workflows.Evals.Results.ListAsync(new WorkflowEvalRunResultsListOptions());
Console.WriteLine(result);
```
```java Java theme={null}
import com.retab.RetabClient;
import com.retab.workflowevalrunresults.WorkflowEvalRunResultsApi;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = new WorkflowEvalRunResultsApi(client).list("run_abc123", null, null, 10L, null);
System.out.println(result);
}
}
```
```curl cURL theme={null}
curl -X 'GET' \
'https://api.retab.com/v1/workflows/evals/results?run_id=wfevalrun_q1z2' \
-H 'Authorization: Bearer '
```
```json 200 theme={null}
{
"data": [
{
"id": "wfresult_a",
"workflow_eval_run_id": "wfevalrun_q1z2",
"eval_id": "wfnodeeval_a",
"workflow_id": "wf_abc123xyz",
"block_id": "block_extract_invoice",
"block_type": "extract",
"lifecycle": { "status": "completed" },
"timing": {
"created_at": "2026-05-18T10:00:00Z",
"started_at": "2026-05-18T10:00:02Z",
"completed_at": "2026-05-18T10:00:20Z",
"duration_ms": 18221
},
"handle_inputs": {},
"handle_outputs": {
"output-json-0": {
"type": "json",
"data": { "total": 1234.56, "vendor": { "name": "Acme Inc" } }
}
},
"warnings": [],
"assertion_result": {
"assertion_id": "assert_xyz",
"condition_kind": "equals",
"outcome": "passed",
"actual_value": 1234.56,
"expected_value": 1234.56,
"failure": null
},
"verdict": "passed",
"verdict_summary": {
"passed": true,
"assertions_passed": 1,
"assertions_failed": 0,
"blocked_assertions": 0,
"failed_assertion_ids": []
}
}
],
"list_metadata": {
"before": null,
"after": null
}
}
```
## OpenAPI
````yaml GET /v1/workflows/evals/results
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
servers:
- url: https://api.retab.com
security: []
paths:
/v1/workflows/evals/results:
get:
tags:
- Workflows
- Workflow Eval Results
summary: List Workflow Eval Results
description: |-
List workflow eval results for a single run, page by page.
Results are returned in run-time order.
operationId: list_workflow_eval_results
parameters:
- in: query
name: run_id
required: true
schema:
type: string
title: Run Id
- in: query
name: before
schema:
anyOf:
- type: string
- type: 'null'
title: Before
required: false
- in: query
name: after
schema:
anyOf:
- type: string
- type: 'null'
title: After
required: false
- in: query
name: limit
schema:
type: integer
maximum: 100
minimum: 1
default: 20
title: Limit
required: false
- in: query
name: order
schema:
enum:
- asc
- desc
type: string
default: desc
title: Order
required: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowEvalResultList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
WorkflowEvalResultList:
description: >-
A page of `WorkflowEvalResult` resources. `data` holds the items and
`list_metadata` carries the `before`/`after` cursors; pass `after` to
fetch the next page.
properties:
data:
items:
$ref: '#/components/schemas/WorkflowEvalResult'
type: array
title: Data
list_metadata:
$ref: '#/components/schemas/ListMetadata'
type: object
required:
- data
- list_metadata
title: WorkflowEvalResultList
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
default: []
type: object
title: HTTPValidationError
WorkflowEvalResult:
properties:
id:
type: string
title: Id
workflow_eval_run_id:
anyOf:
- type: string
- type: 'null'
title: Workflow Eval Run Id
eval_id:
type: string
title: Eval Id
lifecycle:
anyOf:
- oneOf:
- $ref: '#/components/schemas/PendingWorkflowEvalRun'
- $ref: '#/components/schemas/QueuedWorkflowEvalRun'
- $ref: '#/components/schemas/RunningWorkflowEvalRun'
- $ref: '#/components/schemas/CompletedWorkflowEvalRun'
- $ref: '#/components/schemas/ErrorWorkflowEvalRun'
- $ref: '#/components/schemas/CancelledWorkflowEvalRun'
discriminator:
propertyName: status
mapping:
cancelled:
$ref: '#/components/schemas/CancelledWorkflowEvalRun'
completed:
$ref: '#/components/schemas/CompletedWorkflowEvalRun'
error:
$ref: '#/components/schemas/ErrorWorkflowEvalRun'
pending:
$ref: '#/components/schemas/PendingWorkflowEvalRun'
queued:
$ref: '#/components/schemas/QueuedWorkflowEvalRun'
running:
$ref: '#/components/schemas/RunningWorkflowEvalRun'
- type: 'null'
title: Lifecycle
timing:
anyOf:
- $ref: '#/components/schemas/WorkflowEvalRunTiming'
- type: 'null'
verdict:
anyOf:
- type: string
enum:
- passed
- failed
- blocked
- type: 'null'
title: Verdict
description: >-
Verdict label populated only when the underlying eval reaches a
terminal lifecycle state and the verdict could be determined.
Execution-error details flow through `lifecycle`, not through this
enum.
workflow_id:
type: string
title: Workflow Id
block_id:
type: string
title: Block Id
block_type:
type: string
title: Block Type
execution_fingerprint:
anyOf:
- type: string
- type: 'null'
title: Execution Fingerprint
handle_inputs_fingerprint:
anyOf:
- type: string
- type: 'null'
title: Handle Inputs Fingerprint
workflow_draft_fingerprint:
anyOf:
- type: string
- type: 'null'
title: Workflow Draft Fingerprint
block_execution_fingerprint:
anyOf:
- type: string
- type: 'null'
title: Block Execution Fingerprint
artifact:
anyOf:
- $ref: '#/components/schemas/StepArtifactRef'
- type: 'null'
handle_inputs:
additionalProperties:
oneOf:
- $ref: '#/components/schemas/JsonHandleInput'
- $ref: '#/components/schemas/FileHandleInput'
discriminator:
propertyName: type
mapping:
file:
$ref: '#/components/schemas/FileHandleInput'
json:
$ref: '#/components/schemas/JsonHandleInput'
type: object
title: Handle Inputs
default: {}
handle_outputs:
anyOf:
- additionalProperties:
oneOf:
- $ref: '#/components/schemas/JsonHandleInput'
- $ref: '#/components/schemas/FileHandleInput'
discriminator:
propertyName: type
mapping:
file:
$ref: '#/components/schemas/FileHandleInput'
json:
$ref: '#/components/schemas/JsonHandleInput'
type: object
- type: 'null'
title: Handle Outputs
routing_decisions:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Routing Decisions
warnings:
items:
type: string
type: array
title: Warnings
default: []
assertion_result:
anyOf:
- $ref: '#/components/schemas/AssertionResult'
- type: 'null'
verdict_summary:
anyOf:
- $ref: '#/components/schemas/VerdictSummary'
- type: 'null'
type: object
required:
- block_id
- block_type
- eval_id
- id
- workflow_id
title: WorkflowEvalResult
description: >-
The outcome of one eval within an eval run: its `lifecycle`, `timing`,
and `verdict`.
ListMetadata:
properties:
before:
anyOf:
- type: string
- type: 'null'
title: Before
after:
anyOf:
- type: string
- type: 'null'
title: After
type: object
required:
- after
- before
title: ListMetadata
description: Boundary resource IDs for page navigation.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
default: null
ctx:
type: object
title: Context
default: {}
type: object
required:
- loc
- msg
- type
title: ValidationError
PendingWorkflowEvalRun:
properties:
status:
type: string
const: pending
title: Status
default: pending
type: object
title: PendingWorkflowEvalRun
description: The eval run has been created but execution has not started.
QueuedWorkflowEvalRun:
properties:
status:
type: string
const: queued
title: Status
default: queued
type: object
title: QueuedWorkflowEvalRun
description: The eval run is enqueued and waiting for a worker.
RunningWorkflowEvalRun:
properties:
status:
type: string
const: running
title: Status
default: running
type: object
title: RunningWorkflowEvalRun
description: The eval run is executing assertions.
CompletedWorkflowEvalRun:
properties:
status:
type: string
const: completed
title: Status
default: completed
type: object
title: CompletedWorkflowEvalRun
description: The eval run finished. Per-eval verdicts live on each result row.
ErrorWorkflowEvalRun:
properties:
status:
type: string
const: error
title: Status
default: error
message:
type: string
title: Message
description: Human-readable error message
default: (no message)
details:
anyOf:
- $ref: '#/components/schemas/ErrorDetails'
- type: 'null'
description: Structured error context including stack trace
type: object
title: ErrorWorkflowEvalRun
description: |-
The eval run failed. The error message lives on this variant.
Carries the same structured `details` envelope as workflow runs so
consumers can branch on `error_code` / `stage` rather than parsing
a free-text message.
CancelledWorkflowEvalRun:
properties:
status:
type: string
const: cancelled
title: Status
default: cancelled
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
description: Human-readable reason, when known
type: object
title: CancelledWorkflowEvalRun
description: The eval run was cancelled before reaching a natural terminal state.
WorkflowEvalRunTiming:
properties:
created_at:
type: string
format: date-time
title: Created At
description: When the workflow-eval run was created.
started_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Started At
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Duration Ms
type: object
title: WorkflowEvalRunTiming
StepArtifactRef:
properties:
operation:
type: string
enum:
- extraction
- split
- classification
- parse
- edit
- partition
- conditional_evaluation
- review_trigger_evaluation
- while_loop_termination
- api_call_invocation
- function_invocation
title: Operation
description: The kind of resource this artifact references
id:
type: string
title: Id
description: Resource identifier
type: object
required:
- id
- operation
title: StepArtifactRef
description: >-
A resource produced by a workflow step.
An `(operation, id)` reference. The artifact itself carries no payload —
consumers dispatch on `operation` and fetch the referenced record by
`id`.
JsonHandleInput:
properties:
type:
type: string
const: json
title: Type
default: json
data:
title: Data
default: null
additionalProperties: false
type: object
title: JsonHandleInput
description: JSON payload for a handle input. `data` is the raw JSON value.
FileHandleInput:
properties:
type:
type: string
const: file
title: Type
default: file
document:
$ref: '#/components/schemas/ResultFileRef'
additionalProperties: false
type: object
required:
- document
title: FileHandleInput
description: File reference for a handle input.
AssertionResult:
properties:
assertion_id:
type: string
title: Assertion Id
condition_kind:
type: string
title: Condition Kind
outcome:
type: string
enum:
- passed
- failed
- blocked
title: Outcome
actual_value:
title: Actual Value
default: null
expected_value:
title: Expected Value
default: null
score:
anyOf:
- type: number
- type: 'null'
title: Score
threshold:
anyOf:
- type: number
- type: 'null'
title: Threshold
metric_kind:
anyOf:
- type: string
- type: 'null'
title: Metric Kind
assertion_label:
anyOf:
- type: string
- type: 'null'
title: Assertion Label
failure:
anyOf:
- $ref: '#/components/schemas/AssertionFailure'
- type: 'null'
type: object
required:
- assertion_id
- condition_kind
- outcome
title: AssertionResult
description: |-
Result of evaluating ONE assertion against a block's output.
`outcome` is a verdict only — pass / fail / blocked. An execution
error (the assertion couldn't be evaluated because of a type error,
invalid regex, schema validation crash, block execution crash, etc.) is
expressed by `outcome="blocked"` with a populated `failure` whose
`code` identifies the specific failure mode (`execution_error`,
`type_error`, `invalid_regex`, `schema_invalid`,
`block_execution_failed`, ...).
VerdictSummary:
properties:
passed:
type: boolean
title: Passed
assertions_passed:
type: integer
title: Assertions Passed
default: 0
assertions_failed:
type: integer
title: Assertions Failed
default: 0
blocked_assertions:
type: integer
title: Blocked Assertions
default: 0
failed_assertion_ids:
items:
type: string
type: array
title: Failed Assertion Ids
default: []
type: object
required:
- passed
title: VerdictSummary
ErrorDetails:
properties:
message:
anyOf:
- type: string
- type: 'null'
title: Message
description: >-
Human-readable error message. Free-text; the structured fields below
are the machine-readable counterpart.
stack_trace:
anyOf:
- type: string
- type: 'null'
title: Stack Trace
description: Full stack trace
block_id:
anyOf:
- type: string
- type: 'null'
title: Block Id
description: ID of the block that failed
block_name:
anyOf:
- type: string
- type: 'null'
title: Block Name
description: Name/label of the block that failed
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code if available
context:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Context
description: Additional context about the error
type: object
title: ErrorDetails
description: |-
Detailed error information for debugging.
Captures stack traces and context about where and why an error occurred.
ResultFileRef:
properties:
id:
type: string
title: Id
description: ID of the file
filename:
type: string
title: Filename
description: Filename of the file
mime_type:
type: string
title: Mime Type
description: MIME type of the file
type: object
required:
- filename
- id
- mime_type
title: ResultFileRef
description: Public/shared file reference used across SDK and customer-facing APIs.
AssertionFailure:
properties:
code:
type: string
title: Code
message:
type: string
title: Message
details:
additionalProperties: true
type: object
title: Details
default: {}
type: object
required:
- code
- message
title: AssertionFailure
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
````