开发者 API

用同一个 task_id,
接完整自动交付

Web 和 API 共用任务、状态、事件、结果和结算字段。你可以从网页试算开始,也可以直接用 API 创建任务并接收 Webhook。

Webhook payload

{
  "task_id": 123,
  "status": "completed",
  "event_type": "task.completed",
  "created_at": "2026-05-16T00:00:00Z",
  "artifact_ids": [456],
  "final_charge": 19.9
}

默认不暴露 provider 内部细节;需要排查时再开启调试字段。

公开契约

只选择模板和 capability

开发者传入业务输入、模板、规格和幂等键。具体生成路线由系统自动编排,公开 API 不要求你选择内部供应商。

模板与能力

GET/api/templates

查询模板,只返回当前可提交的公开模板。

GET/api/capabilities

查询 capability,了解输入、输出和自动检测口径。

POST/api/quotes

按模板、规格和服务策略试算价格与预算预留。

任务

POST/api/tasks

提交任务,input_payload 可带 prompt、规格和 assets。

GET/api/tasks/{id}

查询同一个 task_id 的状态、events、runs、artifacts 和 cost。

GET/api/tasks/{id}/artifacts

查看交付文件列表。

POST/api/tasks/{id}/share-links

创建私密分享链接,只分享交付结果。

Webhook

GET/api/account/webhooks

查看 Webhook endpoint。

POST/api/account/webhooks

创建 Webhook endpoint。

GET/api/account/webhooks/deliveries

查询投递记录和失败原因。

POST/api/account/webhooks/deliveries/{id}/retry

重新排队一次 Webhook delivery。

账户

GET/api/account/api-keys

查看 API key 列表和最后使用时间。

POST/api/account/api-keys

创建 API key,完整密钥只返回一次。

DELETE/api/account/api-keys/{id}

撤销 API key。

API examples

从查询模板到接收结果

创建任务时建议同时传请求头 Idempotency-Key 和请求体里的幂等键。重复提交同一个业务订单时,系统会返回同一条任务,避免重复预留预算。capability_chainprovider_strategy 由公开模板契约返回,默认使用 auto 编排。

查询模板

GET /api/templates

查询 capability

GET /api/capabilities

试算报价

POST /api/quotes
{
  "template_id": "product-launch",
  "task_type": "text_to_video",
  "provider_strategy": "auto",
  "strategy": "stable",
  "duration_seconds": 5,
  "resolution": "1080p",
  "output_count": 1,
  "execution_mode": "hybrid"
}

创建任务

POST /api/tasks
Idempotency-Key: client-order-10001

{
  "template_id": "product-launch",
  "task_type": "text_to_video",
  "provider_strategy": "auto",
  "strategy": "stable",
  "execution_mode": "hybrid",
  "input_payload": {
    "prompt": "围绕这张产品图生成 5 秒电商展示短视频",
    "duration_seconds": 5,
    "resolution": "1080p",
    "assets": [
      {
        "kind": "product",
        "uri": "imported://product-image-001"
      }
    ]
  },
  "idempotency_key": "client-order-10001"
}

查询任务

GET /api/tasks/{id}

查询结果

GET /api/tasks/{id}/artifacts

创建私密分享

POST /api/tasks/{id}/share-links

重试 Webhook 投递

POST /api/account/webhooks/deliveries/{id}/retry

事件覆盖

Webhook 只发你需要接管的节点

每条 delivery 都会留下可查询记录。投递失败后可以重新排队,不需要把任务状态和回调状态混在一起。

task.created
task.running
task.retrying
task.completed
task.failed
artifact.ready
billing.settled
provider_dry_run.succeeded
provider_dry_run.qa_failed
provider_dry_run.failed
provider_dry_run.blocked