Справочник API

Pipe2.ai предоставляет полноценный GraphQL API. Используйте интерактивную песочницу ниже, чтобы изучать схему, выполнять запросы и тестировать мутации со своим JWT-токеном.

Песочница

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

Аутентификация

Все запросы требуют JWT Bearer-токен. Получите токен в панели управления Pipe2.ai, затем задайте его во вкладке Headers песочницы:

{
  "Authorization": "Bearer YOUR_JWT_TOKEN"
}

Быстрые примеры

Вывести все конвейеры:

query {
  pipelines {
    id
    name
    slug
    credit_cost
    description
  }
}

Запустить конвейер:

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

Проверить баланс кредитов:

mutation {
  get_credit_balance {
    balance
    reserved
    available
  }
}

Справочник по схеме

Автоматически генерируется из актуальной схемы GraphQL — полезно для SEO и быстрого поиска.

Запросы Все доступные GraphQL-запросы — получение конвейеров, ресурсов, запусков и другого.

Мутации Все доступные GraphQL-мутации — запуск конвейеров, управление API-ключами, вставка данных.

Типы Объектные типы, входные типы и перечисления, используемые во всём API.