Skip to content

Promote execution to example

POST
/pipeline-executions/{executionId}/promote-to-example

Create an example from a successful pipeline execution. Either creates a new example set or adds to an existing one.

executionId
required

Unique identifier of the execution to retrieve

string

Unique identifier of the execution to retrieve

object
newExampleSet

Create a new example set with the pipeline’s schema

object
name
required

Name for the new example set

string
>= 1 characters <= 255 characters
description

Description for the new example set

string
existingExampleSetId

ID of an existing example set to add the example to

string
exampleName

Optional name for the example (defaults to execution timestamp)

string
<= 255 characters
rationale

Explanation of why this execution represents correct behavior

string
expectedOutput

Override the expected output (defaults to execution output)

nullable

Example created successfully

object
example
required
object
exampleId
required

ID of the created example

string
exampleSetId
required

ID of the example set

string
name
required

Name of the example

string
nullable
input

Input data from the execution

nullable
expectedOutput

Expected output for the example

nullable
rationale
required

Rationale for this example

string
nullable
exampleSet
required
object
exampleSetId
required

ID of the example set

string
name
required

Name of the example set

string
exampleSetCreated
required

Whether a new example set was created

boolean

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean

Conflict - Resource already exists or operation conflicts with current state

object
error
required
string
code
string
details
nullable
retryable
boolean