POST
/
v2
/
pipelines

Authorizations

lume-api-key
string
headerrequired

Body

application/json
name
string
required

The name of the pipeline. Must be unique within the organization.

target_schema
required

The target JSON schema with which to initialize the first mapper in the pipeline.

sample_data
required

Sample data used to initialize a mapper. Will be executed as a run after initialization.

description
string | null

The description of the pipeline.

Response

200 - application/json

A pipeline organizes mapper versions that operate on the same source data schema. It is initialized with a mapper which can be edited iteratively to produce new versions. A single mapper version is active at a time.

id
string
required

The UUID of the pipeline.

user_id
string
required

The UUID of the user who created the pipeline.

name
string
required

The user-provided name of the pipeline.

created_at
string
required

The date and time this pipeline was created.

description
string | null

The user-provided description of the pipeline.

last_run_status
enum<string> | null

The status of the last run of the active mapper in the pipeline.

Available options:
QUEUED,
RUNNING,
FINISHED,
FAILED,
NEEDS REVIEW
mapper
object

A mapper is a set of transformation logic that maps data from a source schema to a target schema.