PHP SDK

安装和配置 Anthropic PHP SDK，支持值对象和构建器模式

Anthropic PHP 库为任何 PHP 8.1.0+ 应用程序提供对 Anthropic REST API 的便捷访问。

安装

SDK 使用 PSR-18 进行 HTTP 通信，并自动发现任何已安装的 PSR-18 客户端。推荐使用 Guzzle，因为 SDK 会自动为其配置流式传输，无需额外设置：

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

要求

PHP 8.1.0 或更高版本。

用法

此库使用命名参数来指定可选参数。具有默认值的参数必须按名称设置。

<?php

use Anthropic\Client;

$client = new Client(
  apiKey: getenv("ANTHROPIC_API_KEY") ?: "my-anthropic-api-key"
);

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

echo $message->content[0]->text;

有关认证选项（包括 Workload Identity Federation），请参阅认证。

值对象

建议使用静态 with 构造函数 Base64ImageSource::with(data: "U3RhaW5sZXNzIHJvY2tz", ...) 和命名参数来初始化值对象。

但是，也提供了构建器 (new Base64ImageSource)->withData("U3RhaW5sZXNzIHJvY2tz")。

流式传输

SDK 提供使用 Server-Sent Events (SSE) 的流式响应支持。

<?php

use Anthropic\Client;

$client = new Client(
  apiKey: getenv("ANTHROPIC_API_KEY") ?: "my-anthropic-api-key"
);

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

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\Client;

use Anthropic\Core\Exceptions\APIConnectionException;
use Anthropic\Core\Exceptions\APIStatusException;
use Anthropic\Core\Exceptions\RateLimitException;

$client = new Client();

try {
  $message = $client->messages->create(
    maxTokens: 1024,
    messages: [['role' => 'user', 'content' => 'Hello, Claude']],
    model: 'claude-opus-4-7',
  );
} 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();
}

错误代码如下：

重试

某些错误默认会自动重试两次，带有短暂的指数退避。

连接错误（例如，由于网络连接问题）、408 请求超时、409 冲突、429 速率限制、>=500 内部错误和超时默认都会重试。

你可以使用 maxRetries 选项来配置或禁用此功能：

<?php

use Anthropic\Client;
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-4-7',
  requestOptions: RequestOptions::with(maxRetries: 5),
);

分页

Claude API 中的列表方法是分页的。

此库为每个列表响应提供自动分页的迭代器，因此你无需手动请求连续的页面：

<?php

use Anthropic\Client;

$client = new Client(
  apiKey: getenv("ANTHROPIC_API_KEY") ?: "my-anthropic-api-key"
);

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

高级用法

未文档化的属性

你可以向任何端点发送未文档化的参数，并读取未文档化的响应属性，如下所示：

<?php
use Anthropic\Client;

use Anthropic\RequestOptions;

$client = new Client();

$message = $client->messages->create(
  maxTokens: 1024,
  messages: [['role' => 'user', 'content' => 'Hello, Claude']],
  model: 'claude-opus-4-7',
  requestOptions: RequestOptions::with(
    extraQueryParams: ['my_query_parameter' => 'value'],
    extraBodyParams: ['my_body_parameter' => 'value'],
    extraHeaders: ['my-header' => 'value'],
  ),
);

未文档化的请求参数

如果你想显式发送额外参数，可以在发出请求时使用 RequestOptions::with() 下的 extraQueryParams、extraBodyParams 和 extraHeaders 选项，如前面的示例所示。

未文档化的端点

要在保留认证、重试和其他客户端功能的好处的同时向未文档化的端点发送请求，你可以使用 client->request 发送请求，如下所示：

<?php
use Anthropic\Client;
$client = new Client();

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

平台集成

PHP SDK 支持以下平台：

• Bedrock： Anthropic\Bedrock\MantleClient。使用 new MantleClient(awsRegion: ...)。
• Bedrock（旧版）： Anthropic\Bedrock\Client。使用 ::fromEnvironment() 或 ::withCredentials()。
• Vertex AI： Anthropic\Vertex\Client。使用 ::fromEnvironment()。
• Foundry： Anthropic\Foundry\Client。使用 ::withCredentials()。
• Claude Platform on AWS： Anthropic\Aws\Client（需要 aws/aws-sdk-php 作为软依赖）。使用 new Anthropic\Aws\Client(workspaceId: ...) 或设置 ANTHROPIC_AWS_WORKSPACE_ID。目前处于测试阶段。

新项目请使用 MantleClient；Anthropic\Bedrock\Client 保留给使用 Bedrock InvokeModel API 的现有应用程序。

语义化版本控制

此包遵循 SemVer 约定。由于库处于初始开发阶段且主版本号为 0，API 可能随时发生变化。

此包将（非运行时）PHPDoc 类型定义的改进视为非破坏性变更。

附加资源

• GitHub 仓库
• Packagist
• API 参考
• 流式传输 Messages