Dokumentasi · 06

Referensi API.

Satu API HTTP di balik meja kerja, SDK, dan server MCP yang di-host. Semua yang mereka lakukan, Anda juga bisa lakukan dengan kunci dan curl.

URL dasar

lingkunganURL
produksihttps://api.commandagi.com

Awalan /v1 bersifat opsional: /v1/threads dan /threads adalah rute yang sama.

Autentikasi

Kirim kunci API sebagai bearer token:

shell
curl https://api.commandagi.com/v1/me \
  -H "Authorization: Bearer cagi_YOUR_KEY"
  • Kunci berbentuk cagi_ diikuti 64 karakter heksadesimal, dan hanya disimpan sebagai hash.
  • Buat dan cabut kunci di meja kerja dari API keys di menu akun, atau dengan GET/POST /me/api-keys dan DELETE /me/api-keys/:keyId. Agen mendapat kunci sendiri di /agents/:id/keys.
  • Untuk bertindak sebagai salah satu organisasi Anda, tambahkan x-cagi-account: <account id>.
  • Endpoint WebDAV dan Git menerima kunci yang sama sebagai kata sandi autentikasi Basic.

Kunci agen bekerja di dalam akun pemiliknya, tetapi tidak pernah dapat mengubah wewenang. Rute yang membuat izin, menempatkan mesin, atau mengubah pemilik, pengaturan atau kunci penandatanganan menjawab 403 human_principal_required kepada kunci itu.

Menyimpan berkas tanpa kehilangan pekerjaan

Sebuah tulisan menyebut versi yang digantinya: kirim If-Match: "<sha256>" dengan hash yang Anda baca, atau If-None-Match: * untuk membuat berkas yang belum boleh ada. Jika berkas berubah sementara itu, API menjawab 412 dan tidak ada yang ditimpa.

Endpoint

grupendpoint
akunGET POST /accounts · GET /accounts/:id · GET PUT PATCH /accounts/:id/settings · GET /accounts/me/chain
izin tetapGET POST /accounts/:id/standing-grants · DELETE /standing-grants/:id · GET /standing-grants/held
kunci penandatangananGET /accounts/:id/signing-key · POST /accounts/:id/signing-key/rotate
hostGET /accounts/:id/hosts · POST /hosts/:hostId/call
berkasGET /drive · POST /drive/upload · GET PUT /drive/:id/content · PATCH DELETE /drive/:id · POST /drive/folders
agenGET POST /agents · GET PATCH DELETE /agents/:id · GET PUT /default-agents
percakapanGET /me/threads · POST /threads · GET PATCH DELETE /threads/:id · GET /threads/:id/events · POST /threads/:id/inject
perdaganganGET /trading/venues · POST /trading/order · POST /trading/account · POST /trading/cancel
modelGET /models · GET /models/catalog · GET /models/families
MCPPOST /mcp — lihat SDK dan MCP
kesehatanGET /health

Model

GET /models mencantumkan model yang dapat Anda gunakan, sebagai { "models": [ … ] }. Saring dengan ?useCase=. Model first-party adalah commandagi/CommandAGI-000. Model dari penyedia lain dicantumkan dengan id mereka sendiri, dan Anda dapat membawa kunci penyedia sendiri per akun atau organisasi.

Tidak ada endpoint chat-completions yang kompatibel dengan OpenAI. Gunakan percakapan.

Kesalahan

Kode status HTTP menyatakan apa yang salah: 401 tanpa kunci yang valid, 403 ketika prinsipal tidak boleh melakukan ini, 404 ketika tidak ada atau bukan milik Anda untuk dilihat, 412 ketika berkas berubah saat Anda mengerjakannya.