llms.txt dan dokumen Markdown
Semua yang ada di situs dokumentasi ini tersedia dalam dua bentuk: sebagai HTML yang sedang Anda baca dan sebagai Markdown yang dibuat untuk konsumsi mesin. Agen membutuhkan teks bersih dan kaya tautan yang dapat diindeks, diambil, atau dimuat ke dalam konteks. Halaman ini menjelaskan tiga bentuk yang dapat dibaca mesin dan bagaimana ketiganya saling terkait.
Korpus
- /llms.txt, indeks: Titik masuk terkurasi ke produk, panduan developer, alat, dan referensi yang dapat dibaca mesin. File ini mengikuti konvensi llms.txt dan cukup kecil untuk dimuat dalam konteks. Gunakan sebagai titik awal saat agen mengambil halaman sesuai kebutuhan.
- /llms-full.txt, ekspor panduan bahasa Inggris: Dokumen bahasa Inggris yang ditulis manual, digabungkan sebagai Markdown. File ini tidak menyertakan referensi operasi API yang di-generate, referensi SDK yang di-generate, dan dokumentasi yang diimpor. Gunakan saat tugas Anda membutuhkan koleksi panduan yang luas.
- Salinan Markdown per halaman: Setiap halaman juga tersedia sebagai Markdown mentah, sehingga agen dapat mengambil satu halaman tanpa sisa korpus.
Ekspor panduan dan twin Markdown menggunakan sumber terpublikasi yang sama dengan halaman HTML-nya. Indeks terkurasi mengarahkan Anda ke sumber-sumber tersebut. Untuk tugas tertentu, cari di docs dengan endpoint GET publik: ubah q menjadi pertanyaan Anda, lalu ambil markdown_url yang cocok. Pencarian mengembalikan tautan halaman dan bagian beserta perkiraan jumlah token halaman.
Fitur Copy page
Anda jarang perlu mengingat URL tersebut. Setiap halaman di seluruh bagian Guides, referensi API, SDK, dan knowledge base memiliki menu Copy page yang menyerahkan bentuk yang dapat dibaca mesin langsung ke alat Anda:
- Copy page as Markdown: Salinan Markdown halaman saat ini, siap ditempel ke chat atau file konteks.
- Buka llms-full.txt: Koleksi panduan bahasa Inggris untuk tugas yang membutuhkan beberapa panduan.
- Copy MCP install command: Perintah satu baris yang menambahkan server MCP yang di-hosting ke konfigurasi klien Anda, sehingga agen yang membaca halaman juga dapat menghubungkan alat yang diperlukan untuk bertindak.
- Connect to Cursor / Connect to VS Code: Penyiapan MCP sekali klik untuk dua editor agentik yang umum.
Dashboard menawarkan versi yang lebih ringkas dari ide yang sama. Di halaman onboarding email, menu Copy for AI menyalin contoh kode saat ini sebagai prompt siap tempel, atau membukanya langsung di Cursor, Claude, atau ChatGPT.
Referensi API tidak pernah menyimpang
Bagian referensi API di-generate dari spesifikasi OpenAPI yang memvalidasi API. Twin Markdown-nya berasal dari sumber yang sama. Untuk signature operasi dan skema, baca referensi yang di-generate atau spesifikasi OpenAPI publik. Ekspor panduan bahasa Inggris tidak menyertakan halaman operasi yang di-generate. Mulai dari pengantar referensi API untuk melihat bagaimana referensi disusun.
Halaman harga memuat harganya
Halaman harga dan twin Markdown-nya di-render dari data tarif yang sama, dalam permintaan yang sama. /email-api/pricing.md mengembalikan paket email dan kedua tangga volume, /pricing/email.md grid paket pengiriman di setiap volume kirim, /pricing/sms.md kartu tarif per tujuan, /pricing/voice/us.md tarif panggilan per menit untuk suatu tujuan, dan /pricing/sms/fees.md biaya operator dan 10DLC. Mulai dari /pricing.md: file ini mencantumkan setiap produk yang mempublikasikan tarif, halaman harganya, dan URL .md tempat tarif tersebut berada. Tarif yang berasal dari katalog billing diambil saat Anda meminta, bukan disalin ke dalam file, sehingga twin tidak dapat mengutip harga yang sudah berubah di halaman aslinya. Tabel mencantumkan mata uang dan satuan billing yang dipublikasikan. Gunakan mata uang yang disediakan oleh sumber harga.
Memilih bentuk
| Anda ingin agen untuk… | Berikan… |
|---|---|
| Menemukan apa yang tersedia dan mengambil halaman sesuai kebutuhan | /llms.txt |
| Membaca semua panduan bahasa Inggris yang ditulis manual sekaligus | /llms-full.txt |
| Memahami satu topik secara tepat | Markdown halaman tersebut melalui Copy page |
| Bertindak pada Bird sekaligus membaca tentangnya | Server MCP; dokumentasi saja tidak dapat mengirim email |
Untuk penyiapan terpandu dari awal hingga akhir yang menginstal server MCP, menghubungkan editor, dan memasang korpus, ikuti AI onboarding.
Langkah selanjutnya
- AI onboarding: instal server MCP, hubungkan editor, dan pasang korpus.
- Server MCP: biarkan agen Anda bertindak pada Bird sekaligus membaca tentangnya.
- Agent skills: alur kerja siap pakai yang mengajarkan agen pengkodean tentang permukaan Bird.
Sumber daya terkait
Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.
Tonton panduannyaSetting up your coding agentPahami konsepnyaWhat is an MCP server, and how does an agent use one to send messages?Jelajahi kemampuannyaCoding agentsIkuti jalur pembelajaranBuild with AI agents
Dapatkan ringkasan implementasi