spicyapiドキュメント
はじめに
本文

アカウントの準備

アカウントがない状態から、使える API キーを手にするまで約 15 分。登録、メールアドレスの確認、チャージ、キーの作成、無料のテスト呼び出しまで、すべての画面を説明します。

このページでは、「何も持っていない」状態から「キーが動く」状態まで、まっすぐ進みます。コードを書く必要はありません。spicyapi.ai/console のコンソールで画面をクリックしていき、最後にターミナルへコマンドを 1 つ貼り付けるだけです。

最初の生成の前に、次の 3 つが必要です。

必要なもの理由どこで準備するか
メールアドレスを確認済みのアカウントメールアドレスを確認するまでは、有効なキーを使っても、すべての API 呼び出しが 403 で拒否されますステップ 1
0 より多い残高生成の料金は、米ドル建ての前払い残高から支払われます。新しいアカウントの残高は $0 から始まり、無料枠はありません。そのため、残高が空のアカウントで最初の生成を行うと 40201(残高不足)で拒否されますステップ 2
自分のパソコンやサーバーに保管した API キーキーによって、リクエストがどのアカウントのもので、誰の残高から支払うのかを SpicyAPI が判断しますステップ 4

このページでお金がかかる操作

お金がかかるのは、チャージ(ステップ 2)と、有効にした場合の自動チャージ(ステップ 3)だけです。アカウントの作成、キーの作成、ステップ 6 のテスト呼び出しは無料です。残高が使われるのは生成を実行したときだけで、失敗したりタイムアウトしたりした生成の分は、自動的に戻ります。

始める前に

  • 年齢。 アカウントを持てるのは 18 歳以上の方だけです。
  • 利用する場所。 SpicyAPI は、中国本土と、ほかの少数の地域では利用できません。登録と支払いでは接続元が確認され、それらの地域からのリクエストは拒否されます。コンテンツと利用上の責任を参照してください。
  • 登録を一時的に受け付けていないことがあります。 アカウントは順次開放しています。登録ページにアカウントは順次開放中と表示されている場合は、アカウントを申請するを選んでください。アカウントを作成できるようになったらお知らせします。アカウントがなくても、モデルカタログ、スキーマ、価格は閲覧できます。

手順

アカウントを作成し、メールアドレスを確認する

spicyapi.ai/register を開きます。登録方法は 3 つあります。

方法入力するもの知っておきたいこと
Google で続ける または GitHub で続ける何もありません。Google や GitHub のページで許可するだけですそのアカウントのメールアドレスが使われます。そのサービスですでに確認済みのアドレスなら、確認メールは別途届きません。設定 → パスワードでパスワードを設定するまで、アカウントにパスワードはありません(アカウントの閉鎖やチームの譲渡には、あとでパスワードが必要になります)
メールアカウントメールアドレスと、12 文字以上のパスワード確認用のリンクをメールでお送りします

利用規約とプライバシーポリシーへの同意にチェックを入れ、アカウントを作成を選びます。

表示される画面: メールアカウントの場合は、メールをご確認くださいという見出しのページが表示されます。届いたメールを開き、リンクをクリックしてください。メールアドレスを確認しましたというページが表示されれば確認は完了で、コンソールへからコンソールに入れます。

いま起きたこと: アカウントは作成されましたが、API を呼び出せるのはメールアドレスの確認が済んでからです。それまでは、コンソールにメール未確認のため、API 呼び出しは拒否されますというバナーが表示されます。

  • リンクは 1 回だけ使え、24 時間で期限が切れます。期限が切れている場合でもそのリンクを開き、確認リンクを再送するを使うか、コンソールのバナーで確認するを選んでください。
  • 数分たってもメールが届かない場合は、迷惑メールフォルダーを確認し、そのうえでもう一度送信を使ってください。

チャージする

コンソールで請求(spicyapi.ai/console/billing)を開き、残高をチャージで次の手順を進めます。

  1. 金額を選びます。 用意された金額(たとえば $10、$25、$50、$100)から選ぶか、任意の額を選んで金額を入力します。1 回の支払いでチャージできる最小額と最大額は、コンソールに表示されます。オンライン決済では、小数点以下は 2 桁までです。
  2. ボーナスを確認します。 金額によっては、キャンペーンのボーナスが付きます。その場合は、支払う前に +$… ボーナスと表示されます。ボーナスは、支払った金額とは別の項目として追加されます。
  3. 支払い方法を選び、下のタブの手順に従います。

利用できるもの: Visa、Mastercard、American Express、JCB。ブラウザーと端末が対応していれば、Apple Pay と Google Pay も使えます。

  1. カードを選び、Stripe で支払う · $… を選びます。
  2. 安全な決済ページが開きます。そこでカード情報を入力して支払います。SpicyAPI がカード番号を見たり保存したりすることはありません。
  3. 請求ページに戻ります。

表示される画面: まず支払いを送信しましたと表示され、続いて金額が残高に反映されたことが表示されます。利用可能残高が増え、残高の履歴にチャージの項目(ボーナスが付いた場合はボーナスの項目も)が表示されます。

かかる時間: 通常は数秒です。残高が変わるのは、決済事業者からの署名付きの確認が当社に届いてからです。まだ変わっていなければ、少し待ってからページを更新してください。

うまくいかないとき:

  • 決済をキャンセルしましたと表示された場合は、何も請求されておらず、残高も変わっていません。そのままもう一度試せます。
  • 支払う前に決済ページを閉じてしまった場合も、何も請求されていません。チャージ注文に残った未払いの注文は自動的に閉じられるので、新しくチャージを始めてください。
  • サービスを提供できない地域で発行されたカードでの支払いは、残高に反映されません。注文は処理待ちのままとなり、当社のチームが確認します。注文 ID を添えてサポートにお問い合わせください。

ほかに表示されることがあるメッセージ:

  • チャージを利用できません、または現在、チャージ注文を作成できません:チャージの受付を一時的に停止しているか、処理待ちの注文が多すぎます。チャージ注文で古い注文を完了するかキャンセルするか、時間をおいてもう一度お試しください。
  • 通信が途切れたため、結果が確認できません:二重に支払わないよう、もう一度試す前にチャージ注文を確認してください。

任意:自動チャージを有効にする

自動チャージは、残高が少なくなったときに、保存済みのカードに自動で請求します。これにより、時間のかかる処理が途中で 40201 によって止まるのを防げます。使えるのはカードだけです。

  1. 請求で自動チャージを探し、支払い方法を安全に保存を選びます。
  2. 開いた安全なページでカード情報を入力します。カード情報は決済事業者が保管します。
  3. 請求に戻ると、お支払い方法を確認しています、続いてお支払い方法を保存しましたと表示されます。このカードはご利用いただけませんと表示された場合は、何も保存されていません。別のカードを試してください。
  4. 3 つの項目を入力します。
    • 残高がこの額未満でチャージ:請求のきっかけになる残高です。
    • 1 回のチャージ額:1 回の請求で追加する金額です。通常のチャージと同じ範囲内でなければなりません。
    • 月間上限:1 暦月のあいだに自動チャージで請求できる最大額です。1 回のチャージ額より低くはできません。
  5. 許可についての同意にチェックを入れ、自動チャージを開始するを選びます。

表示される画面: 自動チャージを開始しました。上限は以下のとおりです。 と表示されます。カードには、ルール(たとえば「残高が $10 を下回ったら $50 を自動チャージ」)と今月の利用額が表示されます。

ルールの詳細:

  • 残高はおよそ 30 秒〜2 分ごとに確認されます。利用可能残高がしきい値以下になると、保存済みのカードに設定額を請求します。
  • 請求は 1 回ごとに、自動チャージのタグが付いた通常のチャージ注文になります。同じ金額を手動でチャージした場合と同じボーナスが付き、請求書も発行できます。
  • 月間上限は UTC の暦月で数えます。使い切ると、自動チャージは翌月 1 日まで待機します。失敗した請求は上限に含まれません。
  • 請求に失敗した場合は、1 時間後に再試行し、さらに 6 時間後にもう一度試します。3 回続けて失敗すると、自動チャージは自動的にオフになります。盗難や解約などで銀行がカードをはっきり拒否した場合は、即座にオフになります。請求が 1 回成功すると、失敗の回数はリセットされます。
  • 自動的にオフになったあとは、カードの問題を解決する(または新しいカードを保存する)と、もう一度オンにできます。
  • 自動チャージを止めるを選べば、いつでも以後の請求を止められます。残高や、すでに完了したチャージが変わることはありません。

残高不足アラートと組み合わせる

通知で残高不足アラートをオンにし、しきい値を選んでください。残高がそれを下回ると通知が届きます(メールアドレスのあるアカウントにはメールも届きます)。自動チャージがオフの場合や、請求に失敗した場合でも届きます。

API キーを作成する

API キー(spicyapi.ai/console/keys)を開き、キーを作成(または最初のキーを作成)を選びます。

このキーの料金を支払うアカウント

キーは、左サイドバーの上部で選ばれている範囲に属します。チームに参加したことがなければ、そこは常に個人で、キーはあなた自身の残高を使います。先にそこでチームを選ぶと、キーはそのチームに属し、そのキーで送ったタスクの料金はすべてチームのオーナーが支払います。コンソールとチームを参照してください。

API キーを作成ダイアログで必須なのは名前だけです。詳細設定の中の項目は、すべてあとから変更できます。

名前。 キーを使うもの(production backend や my laptop など)にちなんだ名前を付けます。失効させるときに見分けられるようにするためです。120 文字まで入力できます。

消費上限(詳細設定の中にあり、米ドル建て)。上限に達すると、このキーは期間が切り替わるまで、新しいタスクを 40202 で拒否します。ほかのキーはそのまま使えます。まだ実行中のタスクのために仮押さえされている金額は、すべての上限に計上されます。

項目制限する内容リセットされるタイミング作成時に空欄のままにした場合
日次上限このキーが 1 日に使える金額毎日 00:00 UTC上限なし。最初に設定しておく価値がある項目です。流出したキーや暴走したスクリプトの被害を 1 日分で止められます
月間予算このキーが 1 暦月に使える金額毎月 1 日の 00:00 UTC月間の上限なし
累計上限このキーがこれまでに使えるすべての金額リセットされない累計の上限なし

どの上限も、0 を入力すると上限なしになります。空欄のままでも同じ意味になります。

上限欄を空にすると解除されます

あとで既存のキーの編集を選んだときは、上限の欄が空なら上限なしになります。上限を残したい場合は、欄に数値を入れたままにしてください。

利用範囲。

  • 利用を許可するモデル。 初期値の すべてのモデル(制限なし) のままにすると、あとから追加されるモデルも含めて、キーはすべてのモデルを呼び出せます。特定のモデルを選ぶと、それ以外のモデルは 40301 で拒否されます。
  • IP 許可リスト。 すべて許可にすると、どこからの呼び出しも受け付けます。指定したアドレスのみにすると、入力したアドレスからの呼び出しだけを受け付けます。IPv4、IPv6、または 203.0.113.10, 198.51.100.0/24 のような CIDR 範囲を、カンマ区切りで最大 64 件まで入力できます。オフィスや自宅のネットワーク内部のアドレスではなく、サーバーが呼び出しに使う公開アドレスを指定してください。それ以外の場所からの呼び出しは 40302 で拒否されます。アドレスが変わるノートパソコンでは、すべて許可のままにしてください。
  • 有効期限。 7 日、30 日、90 日、1 年、無期限、日付を指定から選びます。キーは UTC でその日が終わった時点で使えなくなり、それ以降は失効したキーと同じ 401 が返ります。

作成を選びます。

表示される画面: キーを作成しましたダイアログに、sk-spicy- で始まるキーの全文が表示されます。キーをコピーでコピーするか、ファイルとして保存を選びます。このキーを安全な場所に保存しましたにチェックを入れ、完了を選びます。

いま起きたこと: キーの全文が表示されるのは、このときだけです。当社が保存しているのはキーの一方向ハッシュだけなので、サポートチームを含め、誰もあとからキーを表示することはできません。なくした場合は、失効させて新しいキーを作成してください。

キーは残高のパスワードとして扱う

キーを持っている人は誰でも、上限か残高の不足で止められるまで、あなたの残高を使えます。

  • 保管場所は、パスワードマネージャー、自分のパソコンの環境変数(次のステップ)、またはサーバーのシークレット設定にしてください。
  • Web ページ、ブラウザー拡張機能、モバイルアプリ、他人に配布するデスクトップアプリには、絶対に入れないでください。 他人の端末で動くものからは、キーを読み出せてしまいます。Web サイトやアプリで生成を使いたい場合は、自分のサーバーを呼び出すようにし、そのサーバーから SpicyAPI を呼び出してください。
  • Git にコミットする、チャットやメールに貼り付ける、スクリーンショットに写す、サポートに送る、といったことは絶対にしないでください。

あとで同じページでできること:

  • 編集では、名前、上限、利用を許可するモデル、IP 許可リスト、有効期限を変更できます。変更はすぐに反映されます。
  • 失効を選ぶとキーは直ちに使えなくなり、元に戻すことはできません。すでに受理されたタスクは実行を続け、料金も通常どおり課金されます。
  • 1 つの範囲で有効なキーは 50 本まで持てます。アプリや環境ごとに 1 本ずつキーを使えば、ほかを止めずに 1 本だけ失効させられます。

キーを SPICY_API_KEY に設定する

環境変数とは、ターミナルが起動するプログラムに渡す、名前付きの値です。公式の SDK、CLI、MCP サーバー、そしてこのドキュメントのすべての例は、SPICY_API_KEY という環境変数からキーを読み取ります。こうしておけば、キーをコマンドに打ち込んだり、プロジェクトの中に保存したりする必要がありません。

まずターミナルを開きます。macOS では Cmd + Space を押して Terminal と入力し、Enter を押します。Windows ではスタートメニューを開いて PowerShell と入力し、Windows PowerShell を開きます。

いま開いているターミナルのウィンドウだけで有効にする場合(ウィンドウを閉じると消えます):

export SPICY_API_KEY="sk-spicy-paste-your-key-here"

ずっと有効にする場合: 同じ export の行を、シェルの起動ファイルの末尾に追加します。起動ファイルは、ターミナルを開くたびに実行されるファイルです。macOS では ~/.zshrc、ほとんどの Linux では ~/.bashrc です。

nano ~/.zshrc

いちばん下にその行を貼り付け、Ctrl + O を押してから Enter で保存し、Ctrl + X で終了します。そのあと、新しいターミナルのウィンドウを開きます。

確認する: キー全体は表示せずに、次のコマンドで確かめます。

echo "${SPICY_API_KEY:0:9}"

期待される結果: sk-spicy- と表示されます。空の行が表示された場合は、このウィンドウで変数が設定されていません。

サーバーでは、プロジェクト内のファイルではなく、ホスティングサービスのシークレット設定や環境変数の設定で SPICY_API_KEY を設定してください。

無料のテスト呼び出しをする

ここでは残高を問い合わせます。費用はかからず、何も作成されません。それでいて、キーが設定されていること、キーが有効であること、アカウントが API を呼び出せる状態であることの 3 つを一度に確かめられます。

curl https://api.spicyapi.ai/api/v1/chat/credit \
  -H "Authorization: Bearer $SPICY_API_KEY"

期待される結果: 次のような応答が返ります(一部省略)。

{
  "code": 200,
  "msg": "success",
  "data": {
    "available": "25",
    "held": "0",
    "total": "25"
  },
  "request_id": "req_01k..."
}

意味: "code": 200 は成功です。金額は米ドルで、文字列として書かれています。available は新しい生成に使える額、held はまだ実行中の生成のために仮押さえされている額、total はその 2 つの合計です。実際の応答には、支払った資金とキャンペーンの付与残高を区別する funding オブジェクトも含まれていますが、いまは気にしなくてかまいません。

別の結果が返った場合:

表示された内容意味対処
"code": 401 と Missing credentials…キーが当社に届いていませんこのウィンドウで SPICY_API_KEY が設定されていません。ステップ 5 をやり直し、新しいウィンドウを開いてください
"code": 401 と API key format is not recognized…送られた値が SpicyAPI のキーではありませんキーをもう一度コピーしてください。キーは sk-spicy- で始まり、途中に空白や引用符が入っていてはいけません
"code": 401 と Credentials are invalid or expiredキーが間違っている、失効している、または有効期限を過ぎていますAPI キーでキーの状態を確認するか、新しいキーを作成してください
"code": 403 と This account cannot call the API right nowキーは問題ありませんが、アカウントがまだ API を使えません。たいていはメールアドレスが未確認なのが原因ですメールアドレスを確認し(ステップ 1)、もう一度試してください
"code": 40302呼び出し元のアドレスが IP 許可リストに含まれていませんキーを編集して公開アドレスを追加するか、すべて許可に戻してください
"code": 40303あなたのいる場所ではサービスを利用できませんコンテンツと利用上の責任を参照してください
"available": "0"すべて正常ですが、まだ残高がありませんステップ 2 を済ませてください。このままでは、最初の生成は 40201 で拒否されます

curl を使いたくない場合は、CLI の spicyapi balance で同じことができます。

これで準備は完了です。最初の生成の前に、費用を確認してください。spicyapi.ai の各モデルページには価格が表示されており、API ではタスクを作成する前に見積もりを取れます。

次のステップ

残高のルール

  • ポイントではなく米ドル。 価格も残高も米ドル建てなので、モデルページに表示された価格がそのまま残高から引かれます。サブスクリプションも月額料金もありません。
  • 入金残高に有効期限はありません。 紹介特典やチャージボーナスなどの特典残高は先に消費され、請求に表示される期限日で失効します。
  • 支払いはタスクごと。 タスクが受理されると、見積額が利用可能残高から仮押さえ(held)されます。タスクが成功すると実際に使った分が課金され、その額が仮押さえ額を超えることはなく、残りは戻ります。失敗・期限切れのタスクでは通常、仮押さえ額が全額解放されます。ただし、モデルページに明記された一部のコンテンツ拒否は、受理時の見積額で課金されます。最終請求額は settled と cost で確認してください。
  • 残高は現金ではありません。 チャージは返金できず、残高を払い出すこともできません。モデルページの課金条件と異なる請求があった、同じチャージが二重に請求された、支払ったのに残高に反映されなかった、など請求に誤りがありそうな場合は、アカウントに登録したメールアドレスから、タスク ID または注文 ID、日付、金額を添えて support@spicyapi.ai にメールしてください。当社が調査し、誤りが確認できたものは残高で訂正します。詳しくは返金・キャンセルポリシーに書かれています。
  • ボーナスに現金としての価値はありません。 ボーナスは支払った金額とは別に記帳され、返金も払い出しもできません。
  • 特典残高と承認済みの後払い枠は、アカウントにある場合にだけ、請求の残高の内訳に表示されます。特典残高は特定のモデルにしか使えない場合があり、期限が切れることもあります。後払い枠は、別途承認を受けた場合にだけ利用できます。
  • 支払いに異議が申し立てられると、利用が一時停止されます。 カード払いについて銀行に異議(チャージバック)が申し立てられると、調査が終わるまで、そのアカウントでの新しいタスクは一時停止されます。請求に心当たりがない場合は、まず当社にご連絡ください。たいていはそのほうが早く解決します。
  • アカウントを閉鎖すると、残高は失われます。 返金も払い出しもされないので、先に使い切ってください。コンソールとチームを参照してください。
  • チームのキーはオーナーの残高を使います。 チームのメンバーがチームのタスクの料金を支払うことはなく、オーナーの残高を見ることもありません。

請求書と領収書

すべて請求 → 請求書(spicyapi.ai/console/billing/invoices)にあります。

  1. 請求先情報を一度だけ登録します。 請求先情報を登録を選びます。必須項目は、名前(組織名または個人名)、住所 1 行目、市区町村、国です。税番号(EU の VAT ID など)は任意です。情報は入力したとおりに印字され、印字できるのはラテン文字、ギリシャ文字、キリル文字だけです。日本語や韓国語の会社名は、登記されているローマ字表記で入力してください。
  2. 請求書を発行を選び、何に対する書類かを選びます。
    • チャージの支払い:支払い済みのチャージ 1 件に対する、支払いの請求書です。経費精算や記帳などで支払いを申告するときに使うのは、この書類です。
    • 1 か月の利用:締まった 1 か月に使った内容の明細です。支払いの領収書ではありません。そのお金はチャージしたときに支払われているので、同じお金について両方の書類を申告に使わないでください。
  3. 発行するを選び、続いて PDF をダウンロードを選びます。

知っておきたいこと:

  • VAT や GST は加算されません。どの請求書にもリバースチャージの注記が入るため、お住まいの国で納めるべき税金がある場合は、ご自身で申告してください。
  • 支払い済みのチャージ 1 件、締まった月 1 か月につき、請求書は 1 回だけ発行できます。すでに発行済みの場合は、それをダウンロードしてください。
  • 情報が間違っていた場合は、修正してから再発行を選びます。古い請求書は無効として記録され、同じ内容を対象とする新しい番号の請求書が発行されます。再発行せずに無効化は、請求書の対象としたチャージや月そのものが間違っていた場合にだけ使ってください。請求書の変更は、1 時間あたりの回数に制限があります。
  • 同じページの下にある月次明細は、1 か月分の残高の履歴を CSV として書き出したもので、ご自身で照合するためのものです。領収書でも税務書類でもありません。
  • チームの場合、請求書はチームのオーナーのアカウントに属します。支払ったのがオーナーだからです。

よくある問題

このページの内容