コンテンツにスキップ

認証

リクエストは API キーで認証します。キーは、Authorization ヘッダに Bearer トークンとして付けて送ります。

Authorization: Bearer YOUR_API_KEY

キーは、ダッシュボードのAPI キーページで作成します。キーに名前を付けます。利用上限と有効期限も設定できます。詳しくは残高とキーの利用上限を参照してください。

ダッシュボードにキーの全文が表示されるのは、作成した直後の 1 回だけです。キーは cherry_ で始まります。キーを紛失したときは、そのキーを失効して、新しいキーを作成してください。失効したキーは、次のリクエストから使えなくなります。

すべてのエンドポイントは、Authorization: Bearer ヘッダでキーを受け取ります。POST /v1/messages は、Anthropic SDK がキーを x-api-key ヘッダに付けて送るため、このヘッダでもキーを受け取ります。ほかのエンドポイントは x-api-key を読みません。

生成のエンドポイント(チャット、画像、動画)、ジョブのエンドポイント、残高とキーのエンドポイント、webhook のエンドポイントには、API キーが必要です。

次のエンドポイントは、API キーが不要です。

  • GET /v1/models
  • GET /v1/models/{vendor}/{model}
  • POST /v1/estimate
  • GET /v1/files/{token}: 出力ファイルの署名付き URL が認証情報の代わりになります。ジョブを参照してください。

有効なキーのないリクエストには、401 とコード unauthorized を返し、レスポンスに WWW-Authenticate: Bearer ヘッダが付きます。キーが指定されていない、形式が不正、存在しない、失効済み、期限切れのどの場合でも同じエラーを返すため、どれに当たるかはエラーから分かりません。キーを最後までコピーできているか確認し、必要なら新しいキーを作成してください。POST /v1/messages は、エラーを Anthropic 形式で返します。チャットを参照してください。

GET /v1/key は、リクエストを送ったキーを返します。名前、末尾の 4 文字、有効期限、利用上限、利用状況が分かります。詳しくは残高とキーの利用上限を参照してください。

ターミナルウィンドウ
curl "https://api.sakuranbo.ai/v1/key" \
-H "Authorization: Bearer $SAKURANBO_API_KEY"

すべてのレスポンスに X-Request-Id ヘッダが付きます。自分のログと突き合わせたいときは、8〜64 文字(A-Z、a-z、0-9、_、-)の X-Request-Id を送ると、その値がリクエスト ID になります。エラーのレスポンスでは、error.request_id に同じ ID が入ります。POST /v1/messages のエラーは Anthropic 形式のため、ID は代わりにトップレベルの request_id フィールドに入ります。

キーは、SAKURANBO_API_KEY のような環境変数に保存してください。クライアント側のコードや公開リポジトリには置かないでください。POST /v1/messages を含め、API はサーバーから呼び出してください。ブラウザは x-api-key ヘッダを API に送れません。API の CORS のルールが、このヘッダを許可していないためです。

コーディングエージェントを接続するときは、MCP サーバーを参照してください。API キーと OAuth のサインインのどちらも使えます。