AGTCloud API Docs
ガイドAPIリファレンス連携とリソース更新とヘルプ

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と対象モデルに適した形式を選択してください。

その他のAPI

API形式から選択

機能ごとに通信方式と結果取得方法が異なります。各Endpointページに記載されたContent-Typeとレスポンスタイプに従ってデータを処理してください。

API形式主な用途クライアントでの処理
同期JSON一般的なテキスト、Embeddings、Rerankリクエスト完了後にJSONレスポンスを解析する
SSEストリーミングChat、Responses、Geminiストリーミングストリームが終了するまでイベントを継続的に読み取る
非同期タスク動画、MidjourneyタスクIDを保存し、ステータスと結果を取得する
Multipartアップロード画像編集、音声文字起こしEndpointの要件に従ってファイルとフォームフィールドを送信する
バイナリレスポンス動画または音声コンテンツのダウンロードレスポンスのメディアタイプに従ってバイトストリームを保存する
WebSocketRealtime接続を維持し、イベントを継続的に交換する

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を公開リポジトリ、スクリーンショット、ログに含めないでください。

続けて読む:共通規約 · APIキーと認証

このページの内容