Run Config

POST

/api/v1/configs/{config_id}/run

Start a new pipeline execution from a configuration.

This is the preferred way to start executions - it ensures full traceability by linking the execution to a stored configuration.

The endpoint:

1. Creates an execution record in the database
2. Loads the pipeline routes from the config
3. Starts all routes in the orchestrator
4. Publishes the init_message to trigger pipeline execution (unless skip_init_message=True)

Args: config_id: Configuration UUID to run service: Execution service (injected) container: Service container (injected) skip_init_message: If True, start routes but don’t publish init_message (for replay scenarios) init_payload_overrides: Override init_message payload fields (merged into YAML defaults)

Returns: Created execution record

Raises: HTTPException: 404 if config not found, 503 if orchestrator not available, 500 for errors

Parameters

Path Parameters

config_id

required

Config Id

string format: uuid

Query Parameters

skip_init_message

Skip Init Message

boolean

tag

Any of:

string

string

null

null

Tag for the new execution (unique)

Request Body

Any of:

object

object

key

additional properties

any

null

null

Responses

201

Successful Response

ExecutionResponse

Pipeline execution response.

Storage paths use execution id (UUID v7) directly.

object

id

required

Id

Execution UUID (used for storage paths)

string format: uuid

config_id

required

Config Id

Configuration ID

string format: uuid

status

required

Status

Current status

string

Allowed values: running completed failed cancelled interrupted

started_at

required

Started At

Start timestamp

string format: date-time

completed_at

Any of:

string

string format: date-time

null

null

parent_execution_id

Any of:

string

string format: uuid

null

null

replay_source

Any of:

string

string

Allowed values: storage lineage manual

null

null

tag

Any of:

string

string

null

null

400

Validation failed

ValidationReportResponse

Validation report returned by the config validator.

Returned verbatim in 200 responses from POST /configs/validate and embedded in 400 responses from create/update/run endpoints when validation fails.

object

is_valid

required

Is Valid

True when no errors present; warnings do not invalidate

boolean

issues

Issues

All findings, errors first then warnings

Array<object>

ValidationIssueResponse

A single validation finding emitted by the pipeline config validator.

object

severity

required

Severity

Error or warning

string

Allowed values: error warning

code

required

Code

Stable error code (e.g. E202, W501)

string

path

required

Path

Path into the config where the issue was found

string

message

required

Message

Human-readable description of the issue

string

suggestion

required

Suggestion

Deterministic, authoritative remediation guidance

string

error_count

required

Error Count

Number of errors

integer

warning_count

required

Warning Count

Number of warnings

integer

404

Resource not found

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object

detail

required

Detail

Error message (matches FastAPI HTTPException)

string

error_code

Any of:

string

string

null

null

correlation_id

Any of:

string

string

null

null

timestamp

Timestamp

Error timestamp

string format: date-time

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object