Envelop umum dan objek yang dapat digunakan ulang di seluruh API Cloud Agents.
Halaman ini mendefinisikan struktur lintas-resource yang digunakan oleh beberapa kelompok API. Struktur khusus resource didokumentasikan pada halaman struktur data masing-masing direktori resource.
Objek metadata
metadata adalah objek flat berisi atribut string yang ditentukan oleh pemanggil.
|
Aturan |
Deskripsi |
|
Bentuk |
Objek JSON yang nilainya berupa string |
|
Jumlah kunci maksimum |
16 |
|
Panjang kunci maksimum |
64 karakter Unicode |
|
Panjang nilai maksimum |
512 karakter Unicode |
|
Nilai default |
|
Contoh:
{
"team": "docs",
"project": "cloud-agents"
}
Daftar terpaginasi
Endpoint daftar mengembalikan envelop paginasi berbasis kursor.
|
Bidang |
Tipe |
Deskripsi |
|
|
array |
Objek resource pada halaman saat ini |
|
|
boolean |
Menunjukkan apakah masih ada catatan tambahan yang tersedia |
|
|
string | null |
ID kursor dari item pertama yang dikembalikan, atau |
|
|
string | null |
ID kursor dari item terakhir yang dikembalikan, atau |
Selubung Error
Tanggapan error menggunakan envelop berikut:
{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Field 'name' is required."
}
}
|
Bidang |
Tipe |
Deskripsi |
|
|
string |
Selalu |
|
|
string |
Kategori error, seperti |
|
|
string |
Pesan error yang dapat dibaca manusia |
Timestamp
Timestamp berupa string ISO 8601 / RFC 3339 dalam UTC, contohnya "2026-05-18T15:26:39.61669Z". Beberapa bidang bersifat nullable; skema resource masing-masing secara eksplisit mencantumkan hal tersebut.
Awalan ID
|
Resource |
Awalan |
|
Agent |
|
|
Environment |
|
|
Session |
|
|
Session event |
|
|
Session thread |
|
|
Turn |
|
|
File |
|
|
Vault |
|
|
Vault credential |
|
|
Skill |
|
|
Memory store |
|
|
Memory entry |
|
|
Memory version |
|