コンテンツへスキップ
ガイド
ガイド

クイックスタート

サポートされている同期またはストリーミングプロトコルを通じてRunAPI言語モデルを呼び出します。

RunAPIは、一般的な公開プロトコルの形式を通じて言語モデルを公開します。既存の互換クライアントをhttps://runapi.aiに向け、RunAPIのモデル識別子を使用し、標準APIキーで認証してください。

プロトコルを選択する

  • OpenAI互換のChat Completionsは POST /v1/chat/completions を使用します。
  • OpenAI互換のResponsesは POST /v1/responses を使用します。
  • Anthropic互換のMessagesは POST /v1/messages を使用します。
  • Gemini互換のコンテンツ生成は /v1beta/models/{model}:generateContent または :streamGenerateContent を使用します。

既存のクライアントとアプリケーションフローに最も適したプロトコルを選択してください。モデルカタログには、各モデルがサポートする公開プロトコルが示されています。

リクエストを送信する

このChat Completionsリクエストは1つの同期レスポンスを返します:

SHELL
curl "https://runapi.ai/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "Summarize why idempotency matters."}]
  }'

リクエストとレスポンスを選択したプロトコルの形式に合わせてください。正確なフィールド、ツール呼び出し、構造化出力、およびモデル固有の制約については、オペレーションの API リファレンスを使用してください。

ストリーム出力

プロトコルのストリーミングオプションを設定し、返されたサーバー送信イベントをインクリメンタルに消費します。Chat Completionsの場合は"stream": trueを追加し、Gemini互換呼び出しの場合は:streamGenerateContentオペレーションを使用します。クライアントがプロトコルの終端イベントを受信したらストリームを閉じてください。

配信の忠実度を検査する

受け入れられたすべてのLLMレスポンスにはX-RunAPI-Fidelityが含まれます。値がfullの場合、リクエストは省略なく配信されたことを意味します。値がlossyの場合、RunAPIはリクエストを完了するためにオプションのコントロールを省略したことを意味し、X-RunAPI-Omitted-Fieldsにはカンマ区切りのフィールド名が含まれます。必須のライフサイクル、継続、ツール、または型付きアイテムのセマンティクスが保持できないリクエストは、Taskが作成される前に拒否されます。

両方のヘッダーはCORSを通じて公開されているため、ブラウザクライアントで検査できます。正確な配信動作がアプリケーションにとって重要な場合は、リクエスト識別子とともにログに記録してください。

エラーと使用量の処理

401を認証失敗として扱い、4xxレスポンスをリクエストまたはポリシーの問題として扱い、一時的なサーバーまたはネットワーク障害のみを再試行してください。選択したプロトコル形式の最終レスポンスまたは終端ストリームイベントからトークン使用量を読み取り、サポートのためにアプリケーションログにリクエスト識別子を保持してください。