---
title: "Create a new pipeline"
method: POST
path: "/pipelines"
tags: ["Pipeline"]
---

# Create a new pipeline

`POST /pipelines`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/pipelines`
- Auth: none declared

Creates a new pipeline definition with its associated steps.
This endpoint defines the sequence of jobs but does not start execution immediately.
Use the 'start' endpoint to begin the pipeline execution.

## Request body

- PipelineConfig
  - `project_id` string, required
  - `name` string, nullable
  - `description` string, nullable
  - `options` PipelineOptions: Options for pipeline execution behavior.
    - `live_progress_updates` boolean, nullable: If True, save checkpoint progress to database during job execution. If None, the worker picks a default based on job type.
  - `elements` object, required

## Response `201`

Successful Response

- PipelineDetail: Model for representing a pipeline with its elements in detail responses.
  - `status` 'pending' | 'running' | 'completed' | 'failed' | 'canceled', required
  - `id` string, required
  - `project_id` string, required
  - `user_id` string, nullable
  - `name` string, required
  - `description` string, nullable
  - `options` PipelineOptions: Options for pipeline execution behavior.
    - `live_progress_updates` boolean, nullable: If True, save checkpoint progress to database during job execution. If None, the worker picks a default based on job type.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `error` string, nullable
  - `error_code` 'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'MAX_BACKWARD_JUMPS_EXCEEDED' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR': Machine-readable error codes for jobs.
  - `created_by_email` string, nullable
  - `organization_id` string, required: Organization this pipeline belongs to.
  - `elements` PipelineElement[]
    - `id` string, required
    - `pipeline_id` string, required
    - `name` string, required
    - `element_order` integer, required: Order of execution within the pipeline (1-based)
    - `element_type` 'Direct Entry' | 'Data Fit' | 'Array Data Fit' | 'Calculation' | 'Validation' | 'Linear Confidence Interval' | 'Sobol Sensitivity', required
    - `job_config` object, required: Configuration parameters for the job
    - `job_id` string, nullable
    - `result` object, nullable
    - `status` 'pending' | 'running' | 'completed' | 'failed' | 'skipped' | 'canceled', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `error` string, nullable
    - `error_code` 'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'MAX_BACKWARD_JUMPS_EXCEEDED' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR': Machine-readable error codes for jobs.
    - `error_detail` object, nullable
    - `job_status` string, nullable: Job status via job_id (from jobs.status).
    - `organization_id` string, required: Organization this pipeline element belongs to.
    - `progress` ElementProgress: Multistart roll-up for a Data Fit element, computed server-side so the UI never has to enumerate child jobs.
      - `multistarts_total` integer, required
      - `multistarts_by_status` object
      - `best_cost` number, nullable
  - `is_terminal` boolean, required: Whether the pipeline has settled and will not transition again.
  - `is_failed` boolean, required: Whether the pipeline settled on anything other than success. Derived as terminal-minus-success, so a new non-success terminal status is classified without editing this method.

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `ea3d377fec1a`: 2 warning
  - added the new `MAX_BACKWARD_JUMPS_EXCEEDED` enum value to the `elements/items/error_code/anyOf[subschema #1: JobErrorCode]/` response property for the response status `201`
  - added the new `MAX_BACKWARD_JUMPS_EXCEEDED` enum value to the `error_code/anyOf[subschema #1: JobErrorCode]/` response property for the response status `201`
- **2026-09-14** `7baccf056192`: 3 info
  - added the optional property `elements/items/progress` to the response with the `201` status
  - added the required property `is_failed` to the response with the `201` status
  - added the required property `is_terminal` to the response with the `201` status
- **2026-09-09** `48c041ad4800`: 2 warning
  - added the new `Linear Confidence Interval` enum value to the `elements/items/element_type` response property for the response status `201`
  - added the new `Sobol Sensitivity` enum value to the `elements/items/element_type` response property for the response status `201`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/pipelines/post.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)