クイックスタート

API キーの作成から非同期タスク、Webhook、成果物のダウンロードまで。

SpicyAPI は画像・動画の非同期タスクと、/v1/chat/completions による通常応答・ストリーミングのテキスト生成を提供します。以下の最短手順で最初の生成を実行できます。

API

GET /api/v1/models?includeSchema=1&includeExamples=1
# choose an item where enabled && available

curl -X POST https://api.spicyapi.ai/api/v1/jobs/createTask \
  -H "Authorization: Bearer $SPICY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: render-001" \
  -d '{
    "model": "MODEL_ID_FROM_CATALOG",
    "input": { "prompt": "a folded paper lantern, hard side light" }
  }'

SDK で送信から待機まで

SDK の client.run(payload, options) は、タスクの送信と結果待機を一つの関数呼び出しにまとめます。HTTP リクエストが一回になるわけではありません。既定のポーリング間隔は約 2 秒から最大 10 秒へ延びます。本番では webhook を優先し、準備済みの output.assets[].url を直接利用してください。

1. API キーを用意する

コンソールでキーを作成し、サーバー側の環境変数 SPICY_API_KEY に保存します。キーをブラウザー、モバイルアプリ、公開リポジトリに埋め込まないでください。

2. タスクを作成する

POST /api/v1/jobs/createTask に model と input を送信します。応答の data.taskId は、状態照会、再試行、ダウンロードで共通して使う識別子です。受理後のタスクは取り消せません。

3. 結果を受け取る

本番環境では webhook を優先し、GET /api/v1/jobs/recordInfo を復旧用ポーリングとして使います。data.state が succeeded のときだけ生成は成功です。

利用可能な output.assets[].url から直接ダウンロードできます。API キーは送信しないでください。expiresAt は通常 20 分後で、生成メディアの保存期限である 14 日を超えません。URL が失効した場合は、保存期間内であれば再照会して更新できます。download-url の呼び出しは任意です。

完全なフィールド定義は OpenAPI 3.1 仕様を参照してください。