Cloud Agents API 全般で使用される共通エンベロープと再利用可能なオブジェクトです。
このページでは、複数の API グループで使用されるリソース共通の構造を定義します。リソース固有の構造は、各リソースディレクトリの data-structures ページに記載されています。
メタデータオブジェクト
メタデータは、呼び出し元定義の文字列属性のフラットオブジェクトです。
|
ルール |
説明 |
|
形状 |
値が文字列の JSON オブジェクト |
|
最大キー数 |
16 |
|
キーの最大長 |
64 Unicode 文字 |
|
値の最大長 |
512 Unicode 文字 |
|
デフォルト |
|
例:
{
"team": "docs",
"project": "cloud-agents"
}
ページ分割されたリスト
リストエンドポイントは、カーソルページネーションのエンベロープを返します。
|
フィールド |
型 |
説明 |
|
|
配列 |
現在のページに含まれるリソースオブジェクト |
|
|
ブール値 |
追加のレコードが存在するかどうか |
|
|
文字列 | null |
最初に返された項目のカーソル ID、または |
|
|
文字列 | null |
最後に返された項目のカーソル ID、または |
エラーエンベロープ
エラーレスポンスでは、このエンベロープを使用します:
{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Field 'name' is required."
}
}
|
フィールド |
型 |
説明 |
|
|
文字列 |
常に |
|
|
文字列 |
|
|
|
文字列 |
人間が判読可能なエラーメッセージ |
タイムスタンプ
タイムスタンプは、UTC の ISO 8601 / RFC 3339 形式の文字列です (例: "2026-05-18T15:26:39.61669Z")。一部のフィールドは null を許容し、そのことは各リソーススキーマで明示的に示されています。
ID プレフィックス
|
リソース |
プレフィックス |
|
エージェント |
|
|
環境 |
|
|
セッション |
|
|
セッションイベント |
|
|
セッションスレッド |
|
|
ターン |
|
|
ファイル |
|
|
Vault |
|
|
Vault 認証情報 |
|
|
スキル |
|
|
メモリストア |
|
|
メモリエントリ |
|
|
メモリバージョン |
|