Claude API adalah RESTful API di https://api.anthropic.com yang menyediakan akses terprogram ke model Claude dan Claude Managed Agents.
Untuk menggunakan Claude API, Anda memerlukan:
Untuk petunjuk penyiapan langkah demi langkah, lihat Memulai.
Claude API mencakup API berikut:
Ketersediaan Umum:
POST /v1/messages)POST /v1/messages/batches)POST /v1/messages/count_tokens)GET /v1/models)Beta:
POST /v1/files, GET /v1/files)POST /v1/skills, GET /v1/skills)POST /v1/agents, GET /v1/agents)POST /v1/sessions, GET /v1/sessions/{id}/events/stream)POST /v1/environments, GET /v1/environments)Untuk referensi API lengkap dengan semua endpoint, parameter, dan skema respons, jelajahi halaman referensi API yang tercantum di navigasi. Untuk mengakses fitur beta, lihat Header beta.
Untuk detail tentang kedua metode autentikasi dan kapan menggunakan masing-masing, lihat Autentikasi. Semua permintaan ke Claude API harus menyertakan header berikut:
| Header | Nilai | Wajib |
|---|---|---|
x-api-key | Kunci API Anda dari Console | Salah satu dari x-api-key atau Authorization |
Authorization | Bearer <token>, di mana <token> adalah token akses berumur pendek yang diperoleh dari POST /v1/oauth/token melalui Workload Identity Federation | Salah satu dari x-api-key atau Authorization |
anthropic-version | Versi API (misalnya, 2023-06-01) | Ya |
content-type | application/json | Ya |
Jika Anda menggunakan SDK Klien, SDK akan mengirim header ini secara otomatis. Untuk detail versi API, lihat Versi API.
Saat mengakses Claude melalui platform cloud, autentikasi terintegrasi dengan sistem IAM penyedia cloud. Lihat dokumentasi khusus platform untuk jenis kredensial yang didukung, header yang diperlukan, dan opsi autentikasi.
API tersedia melalui Console web. Anda dapat menggunakan Workbench untuk mencoba API di browser, lalu membuat kunci API di Pengaturan Akun. Anda memilih masa berlaku setiap kunci saat membuatnya. Gunakan workspace untuk mengelompokkan kunci API Anda dan mengontrol pengeluaran berdasarkan kasus penggunaan.
Anthropic menyediakan SDK resmi yang menyederhanakan integrasi API dengan menangani autentikasi, pemformatan permintaan, penanganan kesalahan, dan lainnya.
Manfaat:
Untuk daftar SDK klien, lihat SDK Klien.
Claude tersedia melalui Claude API langsung dan melalui platform cloud. Pilih berdasarkan infrastruktur, ketersediaan fitur, persyaratan kepatuhan, dan preferensi harga Anda.
Akses Claude melalui AWS, Google Cloud, atau Microsoft Azure:
| Platform | Penyedia | Dokumentasi |
|---|---|---|
| Agent Platform | Google Cloud | Claude di Google Cloud |
| Amazon Bedrock | AWS | Claude di Amazon Bedrock |
| Claude Platform on AWS | AWS (dioperasikan Anthropic) | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure (dioperasikan Anthropic) | Claude di Microsoft Foundry |
| Endpoint | Ukuran permintaan maksimum |
|---|---|
| Messages, Token Counting | 32 MB |
| Message Batches API | 256 MB |
| Files API | 500 MB |
| Sessions, Agents, Environments | 32 MB |
Jika Anda melebihi batas ini, Anda akan menerima kesalahan 413 request_too_large.
Claude API menyertakan header berikut di setiap respons:
request-id: Pengidentifikasi unik global untuk permintaananthropic-organization-id: ID organisasi yang terkait dengan kunci API yang digunakan dalam permintaanEndpoint daftar mengembalikan hasil dalam halaman. Sebagian besar endpoint daftar yang lebih baru menggunakan skema kursor page dan next_page yang dijelaskan di bagian ini. Beberapa menggunakan skema yang berbeda; lihat catatan di akhir bagian ini. Gunakan parameter kueri limit untuk mengontrol ukuran halaman dan parameter kueri page untuk mengambil halaman yang berdekatan. Setiap respons menyertakan array data bersama dengan field kursor untuk menavigasi antar halaman.
| Nama | Lokasi | Deskripsi |
|---|---|---|
limit | Parameter kueri | Jumlah maksimum item yang dikembalikan per halaman. |
page | Parameter kueri | Kursor opaque dari respons sebelumnya. Berikan nilai next_page atau prev_page di sini untuk mengambil halaman yang berdekatan. |
order | Parameter kueri | Arah pengurutan untuk hasil (asc atau desc), pada endpoint daftar yang mendukung pengurutan. Kursor page hanya valid dengan order yang digunakan saat kursor tersebut dibuat. |
next_page | Field respons | Kursor untuk halaman berikutnya, atau null jika tidak ada hasil lagi. |
prev_page | Field respons | Kursor untuk halaman sebelumnya pada endpoint yang mendukung paginasi mundur (saat ini GET /v1/sessions), atau null jika Anda berada di halaman pertama. Endpoint daftar lainnya menghilangkan field ini. |
Untuk kembali satu halaman, berikan prev_page sebagai parameter page. prev_page bernilai null saat Anda berada di halaman pertama. Tidak semua endpoint daftar mendukung prev_page. Hanya GET /v1/sessions yang mengembalikan prev_page; pada endpoint daftar yang tidak mendukung paginasi mundur, field ini tidak ada dalam respons, bukan bernilai null. Untuk panduan permintaan, lihat Mendaftar sesi.
Setiap SDK menyediakan iterator paginasi otomatis yang mengikuti next_page untuk Anda. Di Python dan TypeScript, Anda mendapatkannya dengan mengiterasi hasil daftar secara langsung. SDK lainnya menyediakan iterator melalui metode terpisah. Paginasi otomatis SDK hanya bergerak maju; untuk kembali satu halaman, baca prev_page dari respons dan berikan kembali sebagai parameter page secara manual. Lihat SDK klien untuk detail spesifik bahasa.
API menerapkan batas laju dan batas pengeluaran untuk mencegah penyalahgunaan dan mengelola kapasitas. Batas diatur ke dalam tingkatan penggunaan; organisasi Anda ditempatkan pada suatu tingkatan secara otomatis dan dapat berpindah ke tingkatan yang lebih tinggi seiring waktu. Setiap tingkatan memiliki:
Anda dapat melihat batas laju Anda di halaman Batas laju dan batas pengeluaran Anda di halaman Penagihan di Console. Untuk batas laju yang lebih tinggi atau batas pengeluaran bulanan yang lebih tinggi, gunakan Request rate limit increase di halaman Batas laju.
Untuk informasi terperinci tentang batas, tingkatan, dan algoritma token bucket yang digunakan untuk pembatasan laju, lihat Batas laju.
Claude API tersedia di banyak negara dan wilayah di seluruh dunia. Periksa halaman wilayah yang didukung untuk mengonfirmasi ketersediaan di lokasi Anda.
Spesifikasi API lengkap untuk interaksi model langsung
Endpoint Agents, Sessions, dan Environments
Python, TypeScript, C#, Go, Java, PHP, dan Ruby
Tingkatan penggunaan, meminta batas yang lebih tinggi, dan algoritma token bucket
Was this page helpful?