Docs

基础接入

面向外部调用方的最小接入说明:请求地址、鉴权、参数与常见调用路径。

当前会话变量

正在同步

当前 API Key

未配置

Worker 网关

未配置

DOC_ 变量

无 DOC_ 变量

基础接入

本文档只说明对外调用方式,不涉及内部实现。

1. 请求入口

  • 统一入口:https://<your-worker-domain>/v1/*
  • 例如:
    • POST /v1/images/generations
    • GET /v1/images/generations/{taskId}
    • POST /v1/videos/generations
    • GET /v1/videos/generations/{taskId}

2. 鉴权方式

所有请求都使用你在站点后台创建的 API Key:

Authorization: Bearer YOUR_API_KEY

3. 通用请求头

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

4. 图像生成请求(示例)

接口:POST /v1/images/generations

请求体常用字段:

  • model:模型名,必填
  • prompt:提示词,必填
  • resolution:分辨率(如 1K2K
  • size:画幅(如 1:116:9
  • n:生成数量
  • response_format:返回格式(如 url
curl --request POST \
  --url https://<your-worker-domain>/v1/images/generations \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-2",
    "prompt": "A cinematic poster",
    "resolution": "2K",
    "size": "1:1",
    "n": 1,
    "response_format": "url"
  }'

5. 视频生成请求(示例)

接口:POST /v1/videos/generations

请求体常用字段:

  • model:模型名,必填
  • prompt:提示词,必填
  • duration:时长(秒)
  • aspect_ratio:画幅比例(如 16:9
  • metadata:模型扩展参数(按模型文档传)
curl --request POST \
  --url https://<your-worker-domain>/v1/videos/generations \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "veo3.1-fast",
    "prompt": "A cinematic aerial shot",
    "duration": 8,
    "aspect_ratio": "16:9",
    "metadata": { "resolution": "720p" }
  }'

6. 任务结果查询

图像、视频通常为异步任务。先提交生成请求获取 taskId,再轮询状态接口:

  • 图像状态:GET /v1/images/generations/{taskId}
  • 视频状态:GET /v1/videos/generations/{taskId}
curl --request GET \
  --url https://<your-worker-domain>/v1/images/generations/{taskId} \
  --header 'Authorization: Bearer YOUR_API_KEY'

7. 调用约束

  • 当前不支持流式请求(stream=true)。
  • 请求体中的模型参数按对应模型文档填写;字段名和取值需要与模型页面一致。
  • API Key 代表计费身份,请勿暴露在前端页面或客户端安装包中。