Skip to main content
共通仕様

API 概要

Qoder Cloud Agents API の概要、ゲートウェイ URL、利用可能なリソース、リクエスト制限を紹介します。

はじめに

Qoder Cloud Agents API は、クラウド AI Agent の包括的な管理機能を提供します。Agent の作成、環境設定、セッション管理、イベントストリーム処理などの主要機能をカバーします。すべての API は RESTful 設計に従い、リクエスト / レスポンス形式として JSON を使用します。
現在、API は Beta 段階にあり、一部の機能は今後のバージョンで調整される可能性があります。

ゲートウェイ URL

環境URL
本番環境(Managed Mode)https://api.qoder.com/api/v1/cloud
本番環境(Forward Mode)https://api.qoder.com/api/v1/forward

バージョン

API は現在 v1 バージョンです。エンドポイントはモードに応じて /api/v1/cloud または /api/v1/forward プレフィックスを使用し、追加のバージョンヘッダーは不要です。

利用可能な API 一覧

リソース説明ベースパス
AgentsAgent インスタンスの作成・取得・更新・削除・アーカイブ/agents
Environments実行環境設定の管理/environments
SessionsAgent セッションの作成とライフサイクル管理/sessions
Eventsセッションイベントストリームの読み取りとプッシュ/events
Filesファイルのアップロードと関連付け管理/files
Vaults機密認証情報の安全な保管/vaults
SkillsAgent Skill の登録と管理/skills
Memory Stores永続化されたメモリストア/memory_stores
Deploymentsスケジュールデプロイメントの自動化/deployments
Workセルフホスト Environment の work キューと worker リースのライフサイクル/environments/{environment_id}/work
Forward TemplatesForward Agent テンプレートの定義・バージョン・アーカイブ・クローン/api/v1/forward/templates
Forward IdentitiesForward アイデンティティの作成・有効化/無効化・削除と Agent 照会/api/v1/forward/identities
Forward Service Account Tokensエンタープライズ Service Account Token の作成、Identity への関連付け、失効/api/v1/forward/service_account_tokens
Forward Identity Configsアイデンティティ単位のテンプレート設定と有効設定の照会/api/v1/forward/identities/{identity_id}/templates
Forward ChannelsForward チャネルと QR セッションの管理/api/v1/forward/channels/api/v1/forward/qr_sessions
Forward SessionsForward セッションのライフサイクル・イベント・SSE ストリーム/api/v1/forward/sessions
Forward EnvironmentsForward Environment のライフサイクル管理/api/v1/forward/environments
Forward SkillsForward Skill のライフサイクル管理/api/v1/forward/skills
Forward VaultsForward Vault のライフサイクル管理/api/v1/forward/vaults
Forward CredentialsVault 配下の Credential 管理/api/v1/forward/vaults/{vault_id}/credentials
Forward FilesForward File のアップロード、取得、ダウンロード、削除/api/v1/forward/files
Forward SchedulesForward の定時タスクと実行記録の管理/api/v1/forward/schedules/api/v1/forward/schedule_runs

リクエストサイズ制限

  • 1 回のリクエスト Body の最大値: 4 MB
  • 上限を超えるとサーバー側で Body が切り詰められ、JSON パースに失敗して 400 invalid_request_error(message: "Request body must be valid JSON.")が返されます。

リクエストヘッダー

すべての API リクエストで、認証ヘッダーに PAT または SAT を指定する必要があります。Content-Type は推奨ですが必須ではありません。
Authorization: Bearer $QODER_ACCESS_TOKEN
Content-Type: application/json   # 推奨

レート制限

API アプリケーション層では明示的なレート制限を実装していません。ゲートウェイ層のグローバル保護がリクエスト頻度を管理します。ゲートウェイ保護がトリガーされると HTTP 429 または 503 が返される場合があります。クライアント側では指数バックオフリトライと適度なリクエスト間隔を推奨します。

Beta ステータスについて

  1. API インターフェースは全体として安定していますが、シグネチャは今後のバージョンで微調整される可能性があります。
  2. 新機能は新しい Beta 識別子としてリリースされます。
  3. 本番環境ではバージョンの固定と互換性対応を行うことを推奨します。
  4. Beta 機能を使用する場合は、x-qoder-beta で対応する Beta 識別子を宣言してください。
Beta 識別子対象範囲ガイド
browser-use-2026-07-14browser_toolset_20260714、ブラウザツールおよびライブプレビューBrowser Use(Beta)

接続性のクイック検証

# 現在のアカウント配下の Agent を一覧表示(認証と接続性の確認) \
curl -s https://api.qoder.com/api/v1/cloud/agents?limit=1 \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"
成功時のレスポンス例:
{
  "data": [],
  "first_id": null,
  "last_id": null,
  "has_more": false
}

次のステップ