Referência da API

O Pipe2.ai expõe uma API GraphQL completa. Use o playground interativo abaixo para explorar o schema, executar consultas e testar mutations com seu próprio token JWT.

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

Nota

Você precisa estar autenticado para ver o schema completo. Defina seu token JWT na aba Headers antes de explorar — sem ele, a introspecção será bloqueada.

Autenticação

Todas as requisições exigem um token Bearer JWT. Obtenha seu token no painel do Pipe2.ai e defina-o na aba Headers do playground:

{
  "Authorization": "Bearer YOUR_JWT_TOKEN"
}

Exemplos rápidos

Listar todos os pipelines:

query {
  pipelines {
    id
    name
    slug
    credit_cost
    description
  }
}

Executar um pipeline:

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

Verificar seu saldo de créditos:

mutation {
  get_credit_balance {
    balance
    reserved
    available
  }
}

Referência do schema

Gerada automaticamente a partir do schema GraphQL ao vivo — útil para SEO e consultas rápidas.

Queries Todas as queries GraphQL disponíveis — busque pipelines, assets, execuções e muito mais.

Mutations Todas as mutations GraphQL disponíveis — execute pipelines, gerencie chaves de API, insira dados.

Types Tipos de objeto, tipos de entrada e enums usados em toda a API.