Generic Data Structures - Qoder CN Series - Alibaba Cloud Documentation Center

Shared response envelopes and base objects used across multiple Cloud Agents API resources.

Metadata object

metadata is a flat string key-value object defined by the caller.

Rule	Description
Shape	JSON object; all values must be strings
Maximum key count	16
Maximum key length	64 Unicode characters
Maximum value length	512 Unicode characters
Default	`{}` when omitted

Example:

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

Paginated list

List endpoints return a unified cursor-based pagination envelope.

Field	Type	Description
`data`	array	Array of resource objects on the current page
`has_more`	boolean	Whether more data is available
`first_id`	string \| null	Cursor ID of the first record on the current page; `null` when `data` is empty
`last_id`	string \| null	Cursor ID of the last record on the current page; `null` when `data` is empty

Error envelope

Error responses use the following structure:

{
  "type": "error",
  "request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
  "error": {
    "type": "invalid_request_error",
    "message": "Field 'name' is required."
  }
}

Field	Type	Description
`type`	string	Always `"error"`
`error.type`	string	Error category, such as `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `conflict_error`, or `api_error`
`error.message`	string	Human-readable error message

Timestamps

Time fields are UTC ISO 8601 / RFC 3339 strings, for example "2026-05-18T15:26:39.61669Z". Some fields may be null; refer to the specific resource schema for details.

ID prefixes

Resource	Prefix
Agent	`agent_`
Environment	`env_`
Session	`sess_`
Session event	`evt_`
Session thread	`sthr_`
Turn	`turn_`
File	`file_`
Vault	`vault_`
Vault credential	`vcred_`
Skill	`skill_`
Memory store	`memstore_`
Memory entry	`mem_`
Memory version	`memver_`
Forward template	`tmpl_`
Forward identity	`idn_`
Forward identity config	`cfg_`
Forward channel	`channel_`
Forward QR session	`qr_`
Forward schedule	`sched_`
Forward schedule run	`srun_`
Work item	`work_`
Forward resource	Reuses the registered resource's own ID prefix