API 参考

Pipe2.ai 提供一套完整的 GraphQL API。使用下方的交互式演练场，可以探索 schema、运行查询，并用你自己的 JWT 令牌测试变更（mutation）。

演练场

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

注意

你必须通过身份认证才能看到完整的 schema。在探索之前，先在 Headers 标签页中设置你的 JWT 令牌 —— 否则内省（introspection）将被阻止。

身份认证

所有请求都需要一个 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
  }
}

Schema 参考

根据实时的 GraphQL schema 自动生成 —— 便于 SEO 和快速查阅。

查询（Queries） 所有可用的 GraphQL 查询 —— 获取流水线、素材、运行等。

变更（Mutations） 所有可用的 GraphQL 变更 —— 运行流水线、管理 API 密钥、插入数据。

类型（Types） 贯穿整个 API 使用的对象类型、输入类型和枚举。