APIリファレンス
AGTCloud APIのエンドポイント、リクエストパラメーター、レスポンス構造、オンラインテストを機能別に確認します。
AGTCloudのAPI Referenceでは、各APIのEndpoint、Request Schema、Response構造、コード例、インタラクティブテストを確認できます。まず実行するタスクに対応するAPIを選び、Endpointページで完全なフィールド定義を確認してください。
最初のAPI呼び出しを行う場合
API Key、Base URL、モデルIDをまだ準備していない場合は、クイックスタートから始めてください。基本設定が完了している場合は、以下から必要なAPIを選択します。
コア機能
テキスト、画像、動画は、API Referenceの主要な入口です。機能によって、OpenAI互換形式、プロバイダー固有形式、またはAGTCloudの非同期タスク形式を利用できます。既存のSDKと対象モデルに適した形式を選択してください。
テキストとチャット
Chat Completions、Responses、Anthropic Messages、Gemini Generate Contentなどのプロトコルでテキスト生成や複数ターンの会話を実行します。
画像生成
画像の生成、編集、バリエーション作成のほか、Grok ImageやMidjourneyの非同期タスクAPIを利用します。
動画生成
Platform Video Generations、OpenAI Videos、Grok、Kling、Viduなどで動画を作成し、結果を取得します。
その他のAPI
音声
音声合成、文字起こし、翻訳、非同期音声認識、Voice関連機能を利用します。
Embeddings
テキストまたはToken入力を、セマンティック検索、クラスタリング、類似度計算に使用するベクトルへ変換します。
Rerank
Jina、Cohere、Xinference形式で候補ドキュメントを関連度順に並べ替えます。
Realtime
WebSocketイベントを使用してリアルタイムのテキスト、音声、関数呼び出しを処理します。
API形式から選択
機能ごとに通信方式と結果取得方法が異なります。各Endpointページに記載されたContent-Typeとレスポンスタイプに従ってデータを処理してください。
| API形式 | 主な用途 | クライアントでの処理 |
|---|---|---|
| 同期JSON | 一般的なテキスト、Embeddings、Rerank | リクエスト完了後にJSONレスポンスを解析する |
| SSEストリーミング | Chat、Responses、Geminiストリーミング | ストリームが終了するまでイベントを継続的に読み取る |
| 非同期タスク | 動画、Midjourney | タスクIDを保存し、ステータスと結果を取得する |
| Multipartアップロード | 画像編集、音声文字起こし | Endpointの要件に従ってファイルとフォームフィールドを送信する |
| バイナリレスポンス | 動画または音声コンテンツのダウンロード | レスポンスのメディアタイプに従ってバイトストリームを保存する |
| WebSocket | Realtime | 接続を維持し、イベントを継続的に交換する |
Endpointページの読み方
Endpointと認証を確認する
Endpointで必要なMethod、Path、APIアドレス、認証Headerを確認します。共通ルールは共通規約を参照してください。
リクエストシナリオを選択する
タスクに最も近いリクエスト例を選び、Request Body、Path Parameters、Query Parametersを調整します。
レスポンスとエラーを確認する
HTTPステータスとレスポンスのメディアタイプに従って結果を解析します。リクエストが失敗した場合は、機密情報を除いたエラー詳細とレスポンスに含まれるRequest IDを保存し、エラーとトラブルシューティングを参照してください。
Try Itで確認する
インタラクティブテストでは、現在のページに表示されているAPIアドレスを使用します。アカウントのAPI Keyを入力し、利用可能なモデルを選択してください。共有デバイスでは長期間有効な本番用Keyを使用しないでください。
接続前の共通ルール
- どのテキストプロトコルを使用するか不明な場合は、プロトコルの選択を参照してください。
- Referenceの例にある
MODEL_IDを、現在のAPI Keyで利用できるモデルIDに置き換えてください。 - 同じ機能でも、モデルやプロトコルによって対応フィールドが異なる場合があります。現在のEndpoint、アカウント権限、実際のレスポンスに従ってください。
- 本番アプリケーションでは、ブラウザーコードやクライアントパッケージにAPI Keyをハードコードしないでください。Try Itは一時的なテスト専用です。Keyを公開リポジトリ、スクリーンショット、ログに含めないでください。