跳到正文
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 的問題