API Reference

Pipe2.ai exposes a full GraphQL API. Use the interactive playground below to explore the schema, run queries, and test mutations with your own JWT token.

Playground

Endpoint https://api.pipe2.ai/v1/graphql

Explore the full schema, run queries, and test mutations interactively. Set your JWT token in the Headers tab to authenticate.

Open GraphQL Playground Opens Apollo Sandbox in a new tab

Note

You must be authenticated to see the full schema. Set your JWT token in the Headers tab before exploring — without it, introspection will be blocked.

Authentication

All requests require a JWT Bearer token. Get your token from the Pipe2.ai dashboard, then set it in the playground’s Headers tab:

{
  "Authorization": "Bearer YOUR_JWT_TOKEN"
}

Quick examples

List all pipelines:

query {
  pipelines {
    id
    name
    slug
    credit_cost
    description
  }
}

Run a pipeline:

mutation RunPipeline($input: RunPipelineInput!) {
  run_pipeline(input: $input) {
    pipeline_run_id
  }
}

Check your credit balance:

mutation {
  get_credit_balance {
    balance
    reserved
    available
  }
}

Schema Reference

Auto-generated from the live GraphQL schema — useful for SEO and quick lookups.

Queries All available GraphQL queries — fetch pipelines, assets, runs, and more.

Mutations All available GraphQL mutations — run pipelines, manage API keys, insert data.

Types Object types, input types, and enums used throughout the API.