CircleCI Pipeline API

openapi: 3.1.0
info:
  title: CircleCI REST API V2 Context Pipeline API
  description: The CircleCI REST API v2 provides programmatic access for managing pipelines, projects, workflows, jobs, contexts, and users on the CircleCI continuous integration and delivery platform.
  version: 2.0.0
  contact:
    name: CircleCI Support
    url: https://support.circleci.com/
  license:
    name: Proprietary
    url: https://circleci.com/legal/terms-of-service/
servers:
- url: https://circleci.com/api/v2
  description: CircleCI API v2
security:
- apiTokenAuth: []
- basicAuth: []
tags:
- name: Pipeline
  description: Pipeline trigger and inspection.
paths:
  /pipeline/continue:
    post:
      operationId: continuePipeline
      summary: Continue a pipeline
      description: Continue a pipeline from the setup phase.
      tags:
      - Pipeline
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericRequest'
      responses:
        '200':
          description: Pipeline continued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
  /pipeline/{pipeline-id}:
    get:
      operationId: getPipeline
      summary: Get pipeline by ID
      description: Retrieve pipeline details by unique identifier.
      tags:
      - Pipeline
      parameters:
      - name: pipeline-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Pipeline details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
  /project/{project-slug}/pipeline:
    post:
      operationId: triggerPipeline
      summary: Trigger a new pipeline
      description: Trigger a new pipeline on a project.
      tags:
      - Pipeline
      parameters:
      - name: project-slug
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenericRequest'
      responses:
        '201':
          description: Pipeline triggered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
components:
  schemas:
    GenericResponse:
      type: object
      additionalProperties: true
    GenericRequest:
      type: object
      additionalProperties: true
  securitySchemes:
    apiTokenAuth:
      type: apiKey
      in: header
      name: Circle-Token
      description: CircleCI personal API token.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with API token as username.
x-generated-from: https://circleci.com/docs/api/v2/
x-generated-by: claude-crawl-2026-05-08