Runs
Run Pipeline
Runs
Run Pipeline
Runs a pipeline with the provided sample data. The active mapper version is used by default.
POST
/
v2
/
pipelines
/
{id}
/
runs
Authorizations
lume-api-key
string
headerrequiredPath Parameters
id
required
The ID or name of the pipeline to retrieve.
Body
application/json
data
required
The data to be mapped by the run.
mapper_version
integer | null
The version number of the mapper to use for the run. If omitted, the active version in the pipeline is used.
Response
200 - application/json
A run is a single execution of a mapper.
number
integer
requiredThe run number. Assigned sequentially from zero. Unique within a pipeline for a given mapper version.
user_id
string
requiredThe UUID of the user who created the run.
status
enum<string>
requiredThe status of the run. Run mappings are only available once the run is complete.
Available options:
QUEUED, RUNNING, FINISHED, FAILED, NEEDS REVIEW mapper
object | null
The mapper used to produce the run.
mappings
object | null
The mappings produced by the run.