API Referencefactory

Trigger a line run

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

namestringRequired

Request

This endpoint expects an object.
version_idstring or nullOptionalformat: "uuid"

Deployed line version to run; defaults to latest

regionstring or nullOptional
Compute region override
paramsmap from strings to anyOptional
trigger_payloadmap from strings to anyOptional

Response

Successful Response
idstringformat: "uuid"
line_namestring
line_version_idstringformat: "uuid"
workflow_run_idstringformat: "uuid"
statusstring
triggerobject

What set a run off.

provider, event_name, and delivery_id are lifted out of the nested payload.trigger object so a list row is readable without walking the envelope. The extracted trigger values are not repeated here; they land in the run’s run_params. payload still carries the whole envelope, minus the raw webhook body on list responses.

created_atdatetime
regionstring or nullOptional
run_paramsmap from strings to anyOptional
result_payloadmap from strings to any or nullOptional
error_messagestring or nullOptional
iteration_countintegerOptionalDefaults to 0
budget_used_usdstring or nullOptionalformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
compute_cost_centsintegerOptionalDefaults to 0
inference_cost_centsintegerOptionalDefaults to 0
total_cost_centsintegerOptionalDefaults to 0
cost_rated_atdatetime or nullOptional
retryobject or nullOptional
stageslist of objectsOptional
failureobject or nullOptional

Why a line run ended, and which step surfaced it.

Orchestrator classification (code, domain) is written into result_payload on terminal paths. Step diagnostics are enriched in by the API without replacing those fields.

Read out of result_payload rather than carried as its own request field. api and workflow-handlers are separate Deployments with no rollout ordering, so a new key on a request body is rejected by whichever old pods are still serving — and on LineControlWaitRequest, which forbids extras, that rejection would finalize a succeeded run as failed.

Unknown keys are tolerated for the same reason, in the other direction: a later orchestrator that adds a field here must not make every failure read as unclassified while the rollout is in flight.

triggered_by_actormap from strings to any or nullOptional
started_atdatetime or nullOptional
completed_atdatetime or nullOptional

Errors

422
Unprocessable Entity Error