CLI、SDK、ライブラリクライアントSDK

PHP SDK

値オブジェクトとビルダーパターンを備えたAnthropic PHP SDKのインストールと設定

Anthropic PHPライブラリは、PHP 8.1.0以降のあらゆるアプリケーションからAnthropic REST APIへの便利なアクセスを提供します。

PHP SDKは現在ベータ版です。APIはバージョン間で変更される可能性があります。

コード例を含むAPI機能のドキュメントについては、APIリファレンスを参照してください。このページではPHP固有のSDK機能と設定について説明します。

インストール

SDKはHTTPにPSR-18を使用し、インストールされているPSR-18クライアントを自動的に検出します。Guzzleを推奨します。SDKが追加の設定なしでストリーミング用に構成するためです：

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

要件

PHP 8.1.0以上。

使用方法

このライブラリは、オプション引数を指定するために名前付きパラメータを使用します。デフォルト値を持つパラメータは名前で設定する必要があります。

$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;

Workload Identity Federationを含む認証オプションについては、認証を参照してください。

値オブジェクト

値オブジェクトの初期化には、静的なwithコンストラクタBase64ImageSource::with(data: "U3RhaW5sZXNzIHJvY2tz", ...)と名前付きパラメータを使用することを推奨します。

ただし、ビルダー(new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz")も提供されています。

ストリーミング

SDKは、Server-Sent Events（SSE）を使用した「streaming」（ストリーミング）レスポンスをサポートしています。

$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;
}

ストリーミングには、レスポンスボディを段階的に返すHTTPクライアントが必要です。Guzzleが検出されたPSR-18クライアントである場合、SDKは自動的にストリーミング用に構成します。バッファリングするクライアントの場合、foreachループは段階的にではなく、レスポンスが完了した時点ですべてのイベントを一度に生成します。この症状が見られる場合は、Guzzleをインストールするか、streamingTransporterリクエストオプションを通じてストリーミング対応のPSR-18クライアントを指定してください：

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

エラーハンドリング

ライブラリがAPIに接続できない場合、またはAPIが非成功ステータスコード（つまり、4xxまたは5xxレスポンス）を返した場合、Anthropic\Core\Exceptions\APIExceptionのサブクラスがスローされます：

<?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();
}

エラーコードは以下のとおりです：

原因	エラータイプ
HTTP 400	`BadRequestException`
HTTP 401	`AuthenticationException`
HTTP 403	`PermissionDeniedException`
HTTP 404	`NotFoundException`
HTTP 409	`ConflictException`
HTTP 422	`UnprocessableEntityException`
HTTP 429	`RateLimitException`
HTTP >= 500	`InternalServerException`
その他のHTTPエラー	`APIStatusException`
タイムアウト	`APITimeoutException`
ネットワークエラー	`APIConnectionException`

リトライ

特定のエラーは、デフォルトで短い指数バックオフを伴って2回自動的にリトライされます。

接続エラー（たとえば、ネットワーク接続の問題によるもの）、408 Request Timeout、409 Conflict、429 Rate Limit、500以上の内部エラー、およびタイムアウトは、すべてデフォルトでリトライされます。

maxRetriesオプションを使用して、これを設定または無効化できます：

use Anthropic\RequestOptions;
// ...
// すべてのリクエストに対するデフォルトを設定します:
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// または、リクエストごとに設定します:
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

ページネーション

Claude APIのリストメソッドはページネーションされています。

このライブラリは、各リストレスポンスに自動ページネーションイテレータを提供するため、連続するページを手動でリクエストする必要はありません：

$client = new Client();

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

// 現在のページからアイテムを取得します
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// 追加のネットワークリクエストを行い、現在のページ以降のすべてのページからアイテムを取得します
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}

高度な使用方法

ドキュメント化されていないプロパティ

以下のように、任意のエンドポイントにドキュメント化されていないパラメータを送信したり、ドキュメント化されていないレスポンスプロパティを読み取ったりできます：

同じ名前のextra*パラメータは、ドキュメント化されたパラメータを上書きします。

<?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'],
  ),
);

ドキュメント化されていないリクエストパラメータ

追加のパラメータを明示的に送信したい場合は、前述の例のように、リクエスト時にRequestOptions::with()のextraQueryParams、extraBodyParams、extraHeadersオプションを使用して送信できます。

ドキュメント化されていないエンドポイント

認証、リトライ、その他のクライアント機能の利点を維持しながら、ドキュメント化されていないエンドポイントにリクエストを送信するには、以下のようにclient->requestを使用してリクエストを行うことができます：

$client = new Client();

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

プラットフォーム統合

コード例を含む詳細なプラットフォームセットアップガイドについては、以下を参照してください：

PHP SDKは以下のプラットフォームをサポートしています：

Agent Platform: Anthropic\Vertex\Client。::fromEnvironment()を使用します。
Bedrock: Anthropic\Bedrock\MantleClient。new MantleClient(awsRegion: ...)を使用します。
Bedrock（レガシー）: Anthropic\Bedrock\Client。::fromEnvironment()または::withCredentials()を使用します。
Claude Platform on AWS: Anthropic\Aws\Client（ソフト依存関係としてaws/aws-sdk-phpが必要）。new Anthropic\Aws\Client(workspaceId: ...)を使用するか、ANTHROPIC_AWS_WORKSPACE_IDを設定します。ベータ版で利用可能です。
Foundry: Anthropic\Foundry\Client。::withCredentials()を使用します。

新しいプロジェクトにはMantleClientを使用してください。Anthropic\Bedrock\Clientは、BedrockのInvokeModel APIを使用する既存のアプリケーション向けに残されています。

セマンティックバージョニング

このパッケージはSemVerの規約に従います。ライブラリは初期開発段階にあり、メジャーバージョンが0であるため、APIはいつでも変更される可能性があります。

このパッケージでは、（非ランタイムの）PHPDoc型定義の改善は破壊的変更ではないものとみなします。

その他のリソース

Was this page helpful?

CLI、SDK、ライブラリクライアントSDK

PHP SDK

値オブジェクトとビルダーパターンを備えたAnthropic PHP SDKのインストールと設定

Anthropic PHPライブラリは、PHP 8.1.0以降のあらゆるアプリケーションからAnthropic REST APIへの便利なアクセスを提供します。

PHP SDKは現在ベータ版です。APIはバージョン間で変更される可能性があります。

インストール

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

要件

PHP 8.1.0以上。

使用方法

$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;

Workload Identity Federationを含む認証オプションについては、認証を参照してください。

値オブジェクト

ただし、ビルダー(new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz")も提供されています。

ストリーミング

SDKは、Server-Sent Events（SSE）を使用した「streaming」（ストリーミング）レスポンスをサポートしています。

$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;
}

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

エラーハンドリング

<?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();
}

エラーコードは以下のとおりです：

原因	エラータイプ
HTTP 400	`BadRequestException`
HTTP 401	`AuthenticationException`
HTTP 403	`PermissionDeniedException`
HTTP 404	`NotFoundException`
HTTP 409	`ConflictException`
HTTP 422	`UnprocessableEntityException`
HTTP 429	`RateLimitException`
HTTP >= 500	`InternalServerException`
その他のHTTPエラー	`APIStatusException`
タイムアウト	`APITimeoutException`
ネットワークエラー	`APIConnectionException`

リトライ

特定のエラーは、デフォルトで短い指数バックオフを伴って2回自動的にリトライされます。

maxRetriesオプションを使用して、これを設定または無効化できます：

use Anthropic\RequestOptions;
// ...
// すべてのリクエストに対するデフォルトを設定します:
$client = new Client(requestOptions: RequestOptions::with(maxRetries: 0));

// または、リクエストごとに設定します:
$result = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-5',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

ページネーション

Claude APIのリストメソッドはページネーションされています。

$client = new Client();

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

// 現在のページからアイテムを取得します
foreach ($page->getItems() as $item) {
  echo $item->id, PHP_EOL;
}
// 追加のネットワークリクエストを行い、現在のページ以降のすべてのページからアイテムを取得します
foreach ($page->pagingEachItem() as $item) {
  echo $item->id, PHP_EOL;
}

高度な使用方法

ドキュメント化されていないプロパティ

同じ名前のextra*パラメータは、ドキュメント化されたパラメータを上書きします。

<?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'],
  ),
);

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

$client = new Client();

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

プラットフォーム統合

コード例を含む詳細なプラットフォームセットアップガイドについては、以下を参照してください：

PHP SDKは以下のプラットフォームをサポートしています：

Agent Platform: Anthropic\Vertex\Client。::fromEnvironment()を使用します。
Bedrock: Anthropic\Bedrock\MantleClient。new MantleClient(awsRegion: ...)を使用します。
Bedrock（レガシー）: Anthropic\Bedrock\Client。::fromEnvironment()または::withCredentials()を使用します。
Claude Platform on AWS: Anthropic\Aws\Client（ソフト依存関係としてaws/aws-sdk-phpが必要）。new Anthropic\Aws\Client(workspaceId: ...)を使用するか、ANTHROPIC_AWS_WORKSPACE_IDを設定します。ベータ版で利用可能です。
Foundry: Anthropic\Foundry\Client。::withCredentials()を使用します。

セマンティックバージョニング

このパッケージでは、（非ランタイムの）PHPDoc型定義の改善は破壊的変更ではないものとみなします。

その他のリソース

Was this page helpful?

インストール

要件

使用方法

値オブジェクト

ストリーミング

エラーハンドリング

リトライ

ページネーション

高度な使用方法

ドキュメント化されていないプロパティ

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

プラットフォーム統合

セマンティックバージョニング

その他のリソース

インストール

要件

使用方法

値オブジェクト

ストリーミング

エラーハンドリング

リトライ

ページネーション

高度な使用方法

ドキュメント化されていないプロパティ

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

プラットフォーム統合

セマンティックバージョニング

その他のリソース

インストール

要件

使用方法

値オブジェクト

ストリーミング

エラーハンドリング

リトライ

ページネーション

高度な使用方法

ドキュメント化されていないプロパティ

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

プラットフォーム統合

セマンティックバージョニング

その他のリソース

インストール

要件

使用方法

値オブジェクト

ストリーミング

エラーハンドリング

リトライ

ページネーション

高度な使用方法

ドキュメント化されていないプロパティ

ドキュメント化されていないリクエストパラメータ

ドキュメント化されていないエンドポイント

プラットフォーム統合

セマンティックバージョニング

その他のリソース