コンテンツにスキップ
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 を送り、同じリクエストを送り直すときは同じキーを使います。

使い方

リクエストからファイルまで 3 ステップ

  1. 生成を作成する

    API キーと Idempotency-Key を付けて、モデル ID と入力を送ります。返ってくるのはキューに入った生成と、それが確保したクレジットです。

  2. 進み具合を確認する

    成功、一部成功、失敗、キャンセルのいずれかになるまで、5〜10 秒ごとに生成を読み取ります。使わなかった分は精算時に戻ります。

  3. ファイルをダウンロードする

    納品された出力はそれぞれ当サイト上のファイルにリンクしています。キーで受け取るリンクは署名付きで、1 時間はキーなしで開けます。

権限と上限

キーには許可したことだけをさせる

  • キーは読み取り専用（一覧・取得・ダウンロード）か、生成も可能（作成とキャンセル）のどちらかです。IP 許可リストで自分のサーバーに限定することもできます。

  • 1 回のリクエストで確保できるのは最大 150 クレジットで、有効なモデルのうち最も高いリクエストの料金です。キー自体の設定やリクエストの max_credits では下げることしかできません。

  • キーごとに 1 UTC 日あたり最大 5,000 クレジット、アカウントのすべてのキーの合計で最大 10,000 クレジットまで使えます。API キーのページで別の上限を設定することもできます。

  • キーごと・アカウントごとに、1 分あたり作成とキャンセルは 20 回、読み取りとダウンロードは 240 回まで。同時に実行できる生成は最大 2 件です。

ファイル

OpenAPI ファイルと TypeScript クライアント

OpenAPI 3.1 ファイルには、すべての操作、有効な各モデルの入力、すべてのエラーコードが載っています。TypeScript クライアントはほかのパッケージを必要とせず、再試行のあいだ同じ Idempotency-Key を使い続け、生成を最後まで追跡します。React フックはこれを使ってポーリングします。

API ドキュメントを読むOpenAPI 3.1 ファイルTypeScript クライアントReact ポーリングフック

よくある質問

API についての質問