クイックスタート
API キーを作成して、数分で最初のチャットリクエストを送信します。
このガイドでは、API キーを作成し、
gpt-5.6-solで最初のチャットリクエストを送信する手順を説明します。始める前に、Vergora のコンソールにアクセスできること、およびテストリクエストに十分な残高があることを確認してください。
始める前に
| 項目 | このガイドで使用する設定 | 備考 |
|---|---|---|
| API Origin | https://api.vergora.ai | Vergora API の本番ドメイン |
| リクエストエンドポイント | POST /v1/chat/completions | 完全なリクエスト URL は、API Origin とエンドポイントを組み合わせたものです |
| Model ID | gpt-5.6-sol | 表示名ではなく、正確な ID をコピーしてください |
| API キー | コンソールの「API キー」ページで作成します | Vergora の API キーの代わりにモデルプロバイダーのキーを使用しないでください |
cURL を実行できるターミナルも必要です。以下のコマンドは、macOS、Linux、および Bash または Zsh に対応した環境で動作します。
1. ログインしてコンソールを開く
- ウェブサイトのヘッダーにあるログインを選択します。
- ページの案内に従って、アカウントの認証を完了します。
- コンソールを開き、正しいアカウントとワークスペースを使用していることを確認します。
- 利用可能な残高と、既存の API キーのステータスを確認します。
認証コードが正しくない、または届かない場合は、コードを再度リクエストする前に、メールアドレス、迷惑メールフォルダー、ページ上のメッセージを確認してください。
2. API キーを作成する
- コンソールで API キー を開きます。
- 新しい API キーを作成します。
demo-developmentのように、アプリケーションと環境がわかる名前を付けます。- ページの案内に従って、API キー全体をコピーし、安全な場所に保存します。
API キーは秘密の認証情報です。ブラウザーのコード、公開リポジトリ、チャットメッセージ、ログ、スクリーンショットで公開しないでください。
3. API キーをターミナルに保存する
次のコマンドを使用して API キーを入力します。入力中、キーはターミナルに表示されません。
printf "Vergora API Key: "
read -r -s VERGORA_API_KEY
printf "\n"
export VERGORA_API_KEYこの環境変数は、現在のターミナルセッションでのみ有効です。ターミナルを閉じた後は、再度設定する必要があります。本番環境のアプリケーションでは、認証情報をサーバー側の環境変数またはシークレットマネージャーに保存してください。
4. 最初のリクエストを送信する
同じターミナルで次のコマンドを実行します。
curl --silent --show-error --include \
"https://api.vergora.ai/v1/chat/completions" \
-H "Authorization: Bearer ${VERGORA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.6-sol",
"messages": [
{
"role": "user",
"content": "一文で自己紹介してください。"
}
],
"stream": false
}'この例では Chat Completions エンドポイントを使用しています。モデルを切り替える前に、切り替え先のモデルが同じエンドポイント、メッセージ構造、パラメーターに対応していることを確認してください。
5. レスポンスを読み取る
Chat Completions 互換の非ストリーミングレスポンスには、通常、メッセージの内容と使用量の情報が含まれます。以下のフィールドと値は、結果を読み取る位置を示すための例です。
{
"id": "example-response-id",
"choices": [
{
"message": {
"role": "assistant",
"content": "こんにちは!AI アシスタントです。"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 12,
"completion_tokens": 8,
"total_tokens": 20
}
}次の点を確認します。
- HTTP リクエストが正常に完了したこと。
- レスポンスボディにモデルの出力が含まれていること。
- アプリケーションで
choices[0].message.contentを読み取れること。 - レスポンスに、使用量の情報、またはリクエストの特定に役立つ識別子が含まれていること。
ターミナルにエラーが表示されないことだけで、リクエストが成功したと判断しないでください。
6. リクエストログを確認する
コンソールでリクエストログを開きます。時刻とモデルからリクエストを探し、次の項目を確認します。
| 項目 | 確認する内容 |
|---|---|
| Model ID | モデルが gpt-5.6-sol であること |
| ステータス | リクエストが完了したか、失敗したか |
| 使用量 | 入力トークンと出力トークンが記録されていること |
| レイテンシ | 処理時間が表示されていること |
| コスト | リクエストに対応するコストが表示されていること |
記録がまだ表示されない場合は、同じリクエストを再送信する前に、ページを更新し、適用中のフィルターを確認してください。
トラブルシューティング
| 問題 | 推奨される対応 |
|---|---|
| 認証に失敗した | 環境変数が空でないこと、API キーが完全であること、Bearer とキーの間に半角スペースが 1 つあることを確認します |
| モデルを利用できない | Model ID が gpt-5.6-sol であること、現在のアカウントと API キーがそのモデルにアクセスできることを確認します |
| リクエストの形式が無効 | JSON ボディ、リクエストエンドポイント、Content-Type ヘッダーを確認します |
| 残高または予算が不足している | 利用可能な残高と、API キーの予算上限を確認します |
| リクエストが完了しない | リクエストの時刻と、取得できたリクエスト識別子を控えてから、リクエストログでステータスを確認します |
最初のリクエストが完了したら、認証に進み、API キーの使い方と保護の方法を確認してください。