> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e6data.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a pipeline

> Creates a pipeline and starts it immediately.



## OpenAPI

````yaml /openapi/ingest.yaml post /pipelines
openapi: 3.1.0
info:
  title: Ingest Engine HTTP API
  version: '1.0'
  description: >
    The Ingest Engine exposes an HTTP API for managing pipelines, connections,
    and jobs programmatically.


    All responses are JSON. Errors return an object with an `error` message.


    List endpoints use cursor-based pagination. Responses contain a `data` array
    and a `has_more` flag.

    Pass `?starting_after=<last_id>&limit=10` to get the next page.
servers:
  - url: http://{controllerHost}:8000/api/v1
    description: The Ingest Engine controller.
    variables:
      controllerHost:
        default: localhost
        description: Host name of the Ingest Engine controller.
security:
  - bearerAuth: []
tags:
  - name: Pipelines
    description: Create, update, restart, and delete pipelines.
  - name: Jobs
    description: >-
      A job is a single execution of a pipeline. Each time a pipeline starts or
      restarts, a new job is created.
  - name: Connection profiles
    description: >-
      A connection profile stores reusable connection credentials, such as Kafka
      bootstrap servers and authentication.
  - name: Connection tables
    description: >-
      A connection table defines a specific source or sink, binding a connector,
      connection profile, schema, and table-specific configuration together.
  - name: Connectors
    description: Metadata about available connectors.
  - name: Health
    description: Health checks.
paths:
  /pipelines:
    post:
      tags:
        - Pipelines
      summary: Create a pipeline
      description: Creates a pipeline and starts it immediately.
      operationId: createPipeline
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - query
                - parallelism
              properties:
                name:
                  type: string
                  description: Pipeline name.
                query:
                  type: string
                  description: SQL query defining the pipeline.
                parallelism:
                  type: integer
                  description: Number of parallel subtasks.
                checkpoint_interval_micros:
                  type: integer
                  description: Checkpoint interval in microseconds. Defaults to 30 seconds.
            example:
              name: my-pipeline
              query: INSERT INTO sink SELECT * FROM source
              parallelism: 4
              checkpoint_interval_micros: 30000000
      responses:
        '200':
          $ref: '#/components/responses/Pipeline'
        default:
          $ref: '#/components/responses/Error'
components:
  responses:
    Pipeline:
      description: A `Pipeline` object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Pipeline'
    Error:
      description: Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Pipeline:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        query:
          type: string
        parallelism:
          type: integer
        checkpoint_interval_micros:
          type: integer
        stop:
          $ref: '#/components/schemas/StopMode'
        created_at:
          type: integer
        graph:
          $ref: '#/components/schemas/Graph'
        action:
          type: string
        action_text:
          type: string
        action_in_progress:
          type: boolean
        preview:
          type: boolean
      example:
        id: abc123
        name: my-pipeline
        query: INSERT INTO sink SELECT * FROM source
        parallelism: 4
        checkpoint_interval_micros: 30000000
        stop: none
        created_at: 1700000000000000
        graph:
          nodes: []
          edges: []
        action: stop
        action_text: Stop
        action_in_progress: false
        preview: false
    Error:
      type: object
      properties:
        error:
          type: string
          description: Descriptive error message.
      example:
        error: descriptive error message
    StopMode:
      type: string
      description: Stop mode.
      enum:
        - none
        - graceful
        - immediate
        - checkpoint
        - force
    Graph:
      type: object
      properties:
        nodes:
          type: array
          items: {}
        edges:
          type: array
          items: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send the API token as `Authorization: Bearer <token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.