共通データ構造

このページでは、複数の API グループで使用されるリソース横断的な構造を定義します。リソース固有の構造は各リソースディレクトリのデータ構造ページに記載されています。

メタデータオブジェクト

metadata は呼び出し元が定義する文字列属性のフラットオブジェクトです。

例:

{
  "team": "docs",
  "project": "cloud-agents"
}

リストエンドポイントはカーソルページネーションエンベロープを返します。

フィールド	型	説明
`data`	array	現在のページのリソースオブジェクト
`has_more`	boolean	さらにレコードがあるかどうか
`first_id`	string \| null	最初に返されたアイテムのカーソル ID、`data` が空の場合は `null`
`last_id`	string \| null	最後に返されたアイテムのカーソル ID、`data` が空の場合は `null`

エラーレスポンスは以下のエンベロープを使用します:

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "Field 'name' is required."
  }
}

フィールド	型	説明
`type`	string	固定値 `"error"`
`error.type`	string	エラーカテゴリ。`invalid_request_error`、`authentication_error`、`permission_error`、`not_found_error`、`conflict_error`、`api_error` など
`error.message`	string	人間が読めるエラーメッセージ

タイムスタンプは UTC の ISO 8601 / RFC 3339 文字列です（例: "2026-05-18T15:26:39.61669Z"）。一部のフィールドは null 許容です。詳細は各リソーススキーマに明記されています。

Qoder Cloud Agents の全体像。