Lompat ke konten utama

Dokumentasi

Satu backend, empat cara masuk. Setiap bagian mendokumentasikan kasus penggunaan yang sama, sehingga konsep yang Anda pelajari di REST API adalah konsep yang sama di MCP dan CLI.

  • Memulai

    Otentikasi, ruang kerja, proyek, dan postingan pertama Anda yang dipublikasikan.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

  • API REST

    Sumber daya, penomoran halaman, idempotensi, kode kesalahan, dan batas kecepatan.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

  • server MCP

    Transportasi, OAuth, katalog alat, cakupan, dan jabat tangan persetujuan.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

  • CLI

    Instal, autentikasi, dan kontrak keluaran yang dapat dibaca mesin.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

  • Webhook

    Katalog acara, verifikasi tanda tangan, percobaan ulang, dan pengiriman ulang.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

  • Sesuai persyaratan platform, jenis akun, batasan, dan batasan yang diketahui.

  • Referensi kesalahan

    Setiap kode error, apa penyebabnya, dan apa yang harus dilakukan untuk mengatasinya.

    Belum dipublikasikanBagian ini ditulis berdasarkan API yang dikirimkan dan diterbitkan bersamanya. Kami lebih suka menunjukkan kepada Anda dokumentasi untuk titik akhir yang mungkin berubah.

Apa yang bisa Anda andalkan

  • Setiap penulisan membutuhkan kunci idempotensi. Memutar ulang permintaan dengan kunci yang sama akan mengembalikan hasil asli daripada membuat postingan kedua.
  • Setiap kesalahan membawa kode stabil, kunci pesan, dan detail yang sudah dibersihkan. Kode tidak mengubah arti antar versi.
  • Perubahan yang dapat menyebabkan gangguan mendapatkan versi baru dan jendela penghentian yang diumumkan. Perubahan aditif tidak.
  • Membaca, menyusun, meminta persetujuan, menjadwalkan, dan menerbitkan adalah cakupan yang terpisah. Kredensial mendapatkan kumpulan terkecil yang melakukan tugasnya.

API and MCP Terms