Referensi APIMenggunakan API

Ikhtisar API

Copy page



Pahami endpoint yang tersedia pada Claude API, header autentikasi, SDK klien, paginasi, batas laju, dan opsi akses platform cloud.

Claude API adalah RESTful API di https://api.anthropic.com yang menyediakan akses terprogram ke model Claude dan Claude Managed Agents.

Prasyarat

Untuk menggunakan Claude API, Anda memerlukan:

• Sebuah akun Claude Console
• Sebuah kunci API, atau aturan Workload Identity Federation yang telah dikonfigurasi

Untuk instruksi penyiapan langkah demi langkah, lihat Memulai.

API yang tersedia

Claude API mencakup API berikut:

• Messages API: Kirim pesan ke Claude untuk interaksi percakapan (POST /v1/messages)
• Message Batches API: Proses volume besar permintaan Messages secara asinkron dengan pengurangan biaya 50% (POST /v1/messages/batches)
• Token Counting API: Hitung token dalam sebuah pesan sebelum mengirim untuk mengelola biaya dan batas laju (POST /v1/messages/count_tokens)
• Models API: Daftar model Claude yang tersedia dan detailnya (GET /v1/models)
• Files API: Unggah dan kelola file untuk digunakan di beberapa panggilan API (POST /v1/files, GET /v1/files)
• Skills API: Buat dan kelola keterampilan agen kustom (POST /v1/skills, GET /v1/skills)

API berikut berada dalam tahap beta:

• Agents API: Definisikan konfigurasi agen yang dapat digunakan kembali dan berversi untuk Claude Managed Agents (POST /v1/agents, GET /v1/agents)
• Sessions API: Jalankan sesi agen stateful dalam sandbox cloud terkelola (POST /v1/sessions, GET /v1/sessions/{id}/events/stream)
• Environments API: Konfigurasikan template sandbox untuk sesi agen (POST /v1/environments, GET /v1/environments)

Untuk referensi API lengkap dengan semua endpoint, parameter, dan skema respons, jelajahi halaman referensi API yang tercantum dalam navigasi. Untuk mengakses fitur beta, lihat Beta headers.

Autentikasi

Untuk detail tentang setiap metode autentikasi dan kapan menggunakannya, lihat Autentikasi. Permintaan ke Claude API menyertakan header berikut:

Jika Anda menggunakan SDK Klien, SDK mengirim header autentikasi, versi, dan content-type secara otomatis; Anda meneruskan anthropic-workspace-id sendiri ketika kunci Anda memerlukannya. 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.

Mendapatkan kunci API

API tersedia melalui web Console. Anda dapat menggunakan playground untuk mencoba API di browser dan kemudian menghasilkan kunci API di Account Settings (lihat Dapatkan kunci Claude API Anda). Anda memilih jenis setiap kunci (lihat Jenis kunci) dan kedaluwarsanya saat Anda membuatnya. Gunakan workspaces untuk memisahkan lingkungan dan mengontrol pengeluaran berdasarkan kasus penggunaan.

SDK Klien

Anthropic menyediakan SDK resmi yang menyederhanakan integrasi API dengan menangani autentikasi, pemformatan permintaan, penanganan kesalahan, dan lainnya.

Manfaat:

• Manajemen header otomatis (autentikasi, anthropic-version, content-type)
• Penanganan permintaan dan respons yang aman tipe
• Logika percobaan ulang dan penanganan kesalahan bawaan
• Dukungan streaming
• Timeout permintaan dan manajemen koneksi

Untuk daftar SDK klien, lihat SDK Klien.

Claude API vs platform cloud

Claude tersedia melalui Claude API langsung dan melalui platform cloud. Pilih berdasarkan infrastruktur, ketersediaan fitur, persyaratan kepatuhan, dan preferensi harga Anda.

Claude API

• Akses langsung ke model dan fitur terbaru
• Penagihan dan dukungan Anthropic
• Terbaik untuk: Integrasi baru, akses fitur penuh, hubungan langsung dengan Anthropic

API platform cloud

Akses Claude melalui AWS, Google Cloud, atau Microsoft Azure:

• Terintegrasi dengan penagihan dan IAM penyedia cloud
• Ketersediaan fitur bervariasi menurut platform: Platform yang dioperasikan Anthropic mencakup Claude Platform on AWS dan Microsoft Foundry; platform yang dioperasikan mitra mencakup Amazon Bedrock dan Google Cloud. Lihat halaman setiap platform untuk ketersediaan dan waktu fitur.
• Terbaik untuk: Komitmen cloud yang sudah ada, persyaratan kepatuhan tertentu, penagihan cloud terkonsolidasi

Format permintaan dan respons

Batas ukuran permintaan

Jika Anda melampaui batas ini, Anda akan menerima kesalahan 413 request_too_large.

Header respons

Claude API menyertakan header berikut dalam responsnya:

Untuk header batas laju, lihat Header respons di Batas laju. Untuk contoh yang membaca header respons berdasarkan nama dengan setiap SDK, lihat Identifikasi workspace di balik respons API.

Paginasi

Endpoint 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 di samping bidang kursor untuk menavigasi antar halaman.

Untuk kembali satu halaman, teruskan prev_page sebagai parameter page. prev_page adalah null ketika 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, bidang tersebut tidak ada dalam respons alih-alih 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 maju; untuk kembali satu halaman, baca prev_page dari respons dan teruskan kembali sebagai parameter page sendiri. Lihat SDK klien untuk detail khusus bahasa.

Batas laju dan ketersediaan

Batas laju

API menerapkan batas laju dan batas pengeluaran untuk mencegah penyalahgunaan dan mengelola kapasitas. Batas diatur ke dalam tingkatan penggunaan; organisasi Anda ditempatkan pada tingkatan secara otomatis dan dapat berpindah ke tingkatan yang lebih tinggi seiring waktu. Setiap tingkatan memiliki:

• Batas pengeluaran: Biaya bulanan maksimum untuk penggunaan API
• Batas laju: Jumlah maksimum permintaan per menit (RPM) dan token per menit (TPM)

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.

Ketersediaan

Claude API tersedia di banyak negara dan wilayah di seluruh dunia. Periksa halaman wilayah yang didukung untuk mengonfirmasi ketersediaan di lokasi Anda.

Langkah selanjutnya