Skip to navigation
ReferenceAPI Referenceworkflows

Get Run Data

Paginated script-and-audio data rows for a completed workflow run.

Returns grouped rows where each row represents one source script line. Within each row, cards contain the per-language audio outputs, per-card validation scores (word accuracy, naturalness), and short-lived audio playback_url values (valid for 15 minutes).

Filtering:

  • search narrows which rows are returned based on their source script text.
  • language narrows the cards list within each returned row to a single locale. Rows with no matching cards are still returned (with empty cards), and pagination.total always reflects the search-filtered row count regardless of language.
  • include_dropped=true adds rejected attempts to cards with status="dropped"; the default response remains delivered/generated data only.

Pagination: pagination.total is scoped to the search filter only.

Response includes a partial field indicating whether any data is still being computed (e.g. audio not yet generated, validation not yet scored). This endpoint sets Cache-Control: no-store because playback URLs are short-lived and data may change while a run is still in progress.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"
run_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Query parameters

searchstring or nullOptional<=100 characters

Case-insensitive search over the source/script text of each row.

languagestring or nullOptional<=50 characters

Exact full-locale code to filter cards within each row (e.g. en-US). _ is normalized to -. Filtering is card-level only — rows remain visible even when all their cards are filtered out, and pagination.total is unaffected.

include_droppedbooleanOptionalDefaults to false

Include validator-rejected audio cards reconstructed from unwired fail ports. Defaults to false so existing clients continue receiving delivered output only.

offsetintegerOptional>=0Defaults to 0

Zero-based pagination offset.

limitintegerOptional1-100Defaults to 20

Maximum rows to return (1–100).

Response

Successful Response
dataobject
metaobject
paginationobject
PaginationMeta variant for endpoints that compute an unpaginated total.

Errors

422
Unprocessable Entity Error