跳到正文
FreshApp Demo

开放 API

在你自己的代码里生成内容

从你自己的服务器调用本站的模型：用 API 密钥创建生成任务，跟进到结束，再下载它的文件。

阅读 API 文档管理 API 密钥

API 只扣付费积分：购买过积分包或订阅了有效的付费套餐即可使用。密钥只放在你的服务器上。

请求示例

创建第一个生成任务

export API_ORIGIN='https://demo.freshapp.ai'
export API_KEY='sk_YOUR_API_KEY'

curl --fail-with-body "$API_ORIGIN/api/v1/generations" \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-1001' \
  -d '{"model":"seed-audio-1.0","input":{"prompt":"黎明时分悬崖上的灯塔，海面平静，光线柔和。"}}'

# Read it every 5 to 10 seconds until its status ends.
curl --fail-with-body "$API_ORIGIN/api/v1/generations/GENERATION_ID" \
  -H "Authorization: Bearer $API_KEY"

# A delivered output's url is a signed link: no key needed.
curl --fail-with-body -o result "OUTPUT_URL"

先把 API_KEY 设成你的密钥。每个新请求用一个新的 Idempotency-Key，重发同一个请求时用原来的那个。

使用流程

从请求到文件，三步

  1. 创建生成任务

    带上 API 密钥和 Idempotency-Key，发送模型编号和输入。返回的就是这个任务：排队中，附带它预留的积分。

  2. 跟进任务

    每 5 到 10 秒查询一次，直到它成功、部分成功、失败或被取消。结算时没用掉的积分会退回。

  3. 下载文件

    每个已交付的输出都链接到本站上的文件。密钥拿到的是签名链接，一小时内不带密钥也能打开。

权限和限额

密钥只做你允许的事

  • 密钥要么只读（查列表、查任务、下载），要么还能生成（创建和取消），还可以用 IP 白名单把它限定在你的服务器上。

  • 一次请求最多预留 150 积分，即已启用模型中最贵一次请求的费用；密钥自己的设置和请求里的 max_credits 只能把它调低。

  • 每把密钥每个 UTC 日最多花 5,000 积分，一个账号的所有密钥合计最多 10,000 积分，除非你在 API 密钥页另设上限。

  • 每把密钥、每个账号每分钟最多创建和取消 20 次、查询和下载 240 次，同时运行的任务最多 2 个。

文件下载

OpenAPI 文件和 TypeScript 客户端

OpenAPI 3.1 文件列出全部接口、每个已启用模型的输入和全部错误码。TypeScript 客户端不依赖任何其他包：重试时始终用同一个 Idempotency-Key，并能把一个任务跟进到结束；React hook 用它来轮询。

阅读 API 文档OpenAPI 3.1 文件TypeScript 客户端React 轮询 hook

常见问题

关于 API 的问题