PHP SDK

Library PHP Anthropic menyediakan akses yang mudah ke REST API Anthropic dari aplikasi PHP 8.1.0+ apa pun.



Instalasi

SDK ini menggunakan PSR-18 untuk HTTP dan secara otomatis menemukan klien PSR-18 apa pun yang terinstal. Guzzle direkomendasikan karena SDK mengonfigurasinya untuk streaming tanpa pengaturan tambahan:

composer require "anthropic-ai/sdk" "guzzlehttp/guzzle:^7"



Persyaratan

PHP 8.1.0 atau lebih tinggi.



Penggunaan

Library ini menggunakan named parameter untuk menentukan argumen opsional. Parameter dengan nilai default harus diatur berdasarkan nama.

$client = new Client();

$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
);

$textBlock = array_find($message->content, static fn ($block): bool => $block->type === 'text');
echo $textBlock->text;

Untuk opsi autentikasi termasuk Workload Identity Federation, lihat Autentikasi.



Value object

Disarankan untuk menggunakan konstruktor statis with seperti Base64ImageSource::with(data: "U3RhaW5sZXNzIHJvY2tz", ...) dan named parameter untuk menginisialisasi value object.

Namun, builder juga disediakan (new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz").



Streaming

SDK menyediakan dukungan untuk streaming respons menggunakan Server-Sent Events (SSE).

$client = new Client();

$stream = $client->messages->createStream(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
);

foreach ($stream as $event) {
  echo $event->type . PHP_EOL;
}

Streaming memerlukan klien HTTP yang mengembalikan body respons secara bertahap. Ketika Guzzle adalah klien PSR-18 yang ditemukan, SDK mengonfigurasinya untuk streaming secara otomatis. Dengan klien yang melakukan buffering, loop foreach menghasilkan semua event sekaligus ketika respons selesai alih-alih secara bertahap; jika Anda mengamati gejala tersebut, instal Guzzle atau sediakan klien PSR-18 yang mendukung streaming melalui opsi permintaan streamingTransporter:

$client = new Anthropic\Client(
  requestOptions: Anthropic\RequestOptions::with(streamingTransporter: $myStreamingClient),
);



Penanganan error

Ketika library tidak dapat terhubung ke API, atau jika API mengembalikan kode status non-sukses (yaitu, respons 4xx atau 5xx), subclass dari Anthropic\Core\Exceptions\APIException akan dilempar:

<?php
// ...
use Anthropic\Core\Exceptions\APIConnectionException;
use Anthropic\Core\Exceptions\APIStatusException;
use Anthropic\Core\Exceptions\RateLimitException;
// ...
try {
  $message = $client->messages->create(
    maxTokens: 1024,
    messages: [['role' => 'user', 'content' => 'Hello, Claude']],
    model: 'claude-opus-5',
  );
} catch (APIConnectionException $e) {
  echo "The server could not be reached", PHP_EOL;
  echo $e->getPrevious()?->getMessage(), PHP_EOL;
} catch (RateLimitException $_) {
  echo "A 429 status code was received; we should back off a bit.", PHP_EOL;
} catch (APIStatusException $e) {
  echo "Another non-200-range status code was received", PHP_EOL;
  echo $e->getMessage();
}

Kode error adalah sebagai berikut:



Percobaan ulang

Error tertentu secara otomatis dicoba ulang dua kali secara default, dengan exponential backoff singkat.

Error koneksi (misalnya, karena masalah konektivitas jaringan), 408 Request Timeout, 409 Conflict, 429 Rate Limit, error Internal >=500, dan timeout semuanya dicoba ulang secara default.

Anda dapat menggunakan opsi maxRetries untuk mengonfigurasi atau menonaktifkan ini:

use Anthropic\RequestOptions;
// ...
// Konfigurasikan default untuk semua permintaan:
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// Atau, konfigurasikan per permintaan:
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
  requestOptions: RequestOptions::with(maxRetries: 5),
);



Paginasi

Metode list di Claude API menggunakan paginasi.

Library ini menyediakan iterator dengan paginasi otomatis pada setiap respons list, sehingga Anda tidak perlu meminta halaman berikutnya secara manual:

$client = new Client();

$page = $client->beta->messages->batches->list(limit: 20);

// mengambil item dari halaman saat ini
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// membuat permintaan jaringan tambahan untuk mengambil item dari semua halaman, termasuk halaman saat ini dan setelahnya
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}



Penggunaan lanjutan



Properti yang tidak terdokumentasi

Anda dapat mengirim parameter yang tidak terdokumentasi ke endpoint mana pun, dan membaca properti respons yang tidak terdokumentasi, sebagai berikut:

<?php
// ...
use Anthropic\RequestOptions;
// ...
$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
  requestOptions: RequestOptions::with(
    extraQueryParams: ['my_query_parameter' => 'value'],
    extraBodyParams: ['my_body_parameter' => 'value'],
    extraHeaders: ['my-header' => 'value'],
  ),
);



Parameter permintaan yang tidak terdokumentasi

Jika Anda ingin secara eksplisit mengirim parameter tambahan, Anda dapat melakukannya dengan opsi extraQueryParams, extraBodyParams, dan extraHeaders di bawah RequestOptions::with() saat membuat permintaan, seperti yang terlihat pada contoh sebelumnya.



Endpoint yang tidak terdokumentasi

Untuk membuat permintaan ke endpoint yang tidak terdokumentasi sambil tetap mempertahankan manfaat autentikasi, percobaan ulang, dan fitur klien lainnya, Anda dapat membuat permintaan menggunakan client->request, sebagai berikut:

$client = new Client();

$response = $client->request(
  method: "post",
  path: '/undocumented/endpoint',
  query: ['dog' => 'woof'],
  headers: ['useful-header' => 'interesting-value'],
  body: ['hello' => 'world']
);



Integrasi platform

PHP SDK mendukung platform berikut:

• Agent Platform: Anthropic\Vertex\Client. Gunakan ::fromEnvironment().
• Bedrock: Anthropic\Bedrock\MantleClient. Gunakan new MantleClient(awsRegion: ...).
• Bedrock (legacy): Anthropic\Bedrock\Client. Gunakan ::fromEnvironment() atau ::withCredentials().
• Claude Platform di AWS: Anthropic\Aws\Client (memerlukan aws/aws-sdk-php sebagai soft dependency). Gunakan new Anthropic\Aws\Client(workspaceId: ...) atau atur ANTHROPIC_AWS_WORKSPACE_ID. Tersedia dalam beta.
• Foundry: Anthropic\Foundry\Client. Gunakan ::withCredentials().

Gunakan MantleClient untuk proyek baru; Anthropic\Bedrock\Client tetap tersedia untuk aplikasi yang sudah ada yang menggunakan API InvokeModel Bedrock.



Semantic versioning

Paket ini mengikuti konvensi SemVer. Karena library ini masih dalam pengembangan awal dan memiliki versi mayor 0, API dapat berubah kapan saja.

Paket ini menganggap perbaikan pada definisi tipe PHPDoc (non-runtime) sebagai perubahan yang tidak merusak kompatibilitas.



Sumber daya tambahan

• Repositori GitHub
• Packagist
• Referensi API
• Streaming Messages