Skip to navigation
API Referencefactories

Steer Scoped Factory Line Run

Authentication

AuthorizationBearer

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

Path parameters

factory_idstringRequired
run_idstringRequiredformat: "uuid"

Headers

X-Islo-Api-VersionstringRequired

Request

This endpoint expects an object.
stage_namestringRequired
paramsmap from strings to anyOptional
reasonstring or nullOptional
reset_iterationsbooleanOptionalDefaults to false
reset_usagebooleanOptionalDefaults to false

Response

Successful Response
created_atdatetime
idstringformat: "uuid"
line_namestring
line_versionobject
The retained line version attached to a historical run.
line_version_idstringformat: "uuid"
namestring
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.

workflow_run_idstringformat: "uuid"
active_secondsdoubleOptionalDefaults to 0
budget_used_usdstring or nullOptionalformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
completed_atdatetime or nullOptional
compute_cost_centsintegerOptionalDefaults to 0
cost_rated_atdatetime or nullOptional
error_messagestring or nullOptional
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.

inference_cost_centsintegerOptionalDefaults to 0
iteration_countintegerOptionalDefaults to 0
limitsmap from strings to anyOptional
regionstring or nullOptional
result_payloadmap from strings to any or nullOptional
retryobject or nullOptional
run_paramsmap from strings to anyOptional
stageslist of objectsOptional
started_atdatetime or nullOptional
total_cost_centsintegerOptionalDefaults to 0
triggered_by_actorobject or nullOptional
usage_reset_atdatetime or nullOptional
waiting_machinemap from strings to any or nullOptional

Errors

422
Unprocessable Entity Error