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

ノート

完全なスキーマを表示するには認証が必要です。探索を始める前に Headers タブで JWT トークンを設定してください — 設定しないとイントロスペクションはブロックされます。

認証

すべてのリクエストには 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 全体で使われるオブジェクト型、入力型、列挙型。