Skip to main content
POST
Promote run to example

Authorizations

Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Run id.

Body

application/json

Create or update a dataset example from the run input, actual output, and review corrections.

name
string

Dataset example name to create or update. Defaults to a generated name when omitted.

Required string length: 1 - 128

Response

Created or updated a dataset example from the run

automationId
string
required

Automation that owns the promoted example.

automationType
enum<string>
required

Implementation type behind the automation.

Available options:
workflow,
agent
exampleId
string
required

Dataset example identifier returned for follow-up API calls.

name
string | null
required

Dataset example name.