PHPackages                             eitqan-hub/claude-3-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. eitqan-hub/claude-3-api

ActiveLibrary[API Development](/categories/api)

eitqan-hub/claude-3-api
=======================

A PHP package for the Claude 3.7 Sonnet API

0.1.24(1y ago)013MITPHPPHP ^8.4

Since Mar 8Pushed 1y agoCompare

[ Source](https://github.com/eitqan-hub/claude-3-api)[ Packagist](https://packagist.org/packages/eitqan-hub/claude-3-api)[ RSS](/packages/eitqan-hub-claude-3-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

Claude 3 API PHP Package
========================

[](#claude-3-api-php-package)

A robust PHP package for interacting with Anthropic's Claude 3 API, supporting both text and vision capabilities.

Features
--------

[](#features)

- Easy-to-use interface for sending messages to Claude (default), OpenAI and DeepSeek
- Support for text-based conversations with a simple chat method
- Streaming support for real-time responses
- Vision capabilities - send images along with text prompts (Claude only)
- Tool usage support (Claude only)
- Prompt caching support for improved performance and cost efficiency (Claude only)
- Comprehensive error handling
- Fully tested with PHPUnit

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require eitqan-hub/claude-3-api
```

Usage
-----

[](#usage)

### Basic Chat Usage

[](#basic-chat-usage)

For simple text-based interactions, you can use the `chat` method:

### Basic Chat Usage

[](#basic-chat-usage-1)

For simple text-based interactions, you can use the `chat` method in several ways:

1. Send a single string message:

```
use Claude\Claude3Api\Client;
use Claude\Claude3Api\Config;

// Create a configuration object with your API key
$config = new Config('your-api-key-here');

// Create a client
$client = new Client($config);

// Send a single string message
$response = $client->chat("Hello, Claude");

echo "Claude's response: " . $response->getContent()[0]['text'];
```

2. Send a single message as an array:

```
$response = $client->chat(['role' => 'user', "content" => "Hello, Claude"]);

echo "Claude's response: " . $response->getContent()[0]['text'];
```

3. Continue a conversation with multiple messages:

```
$response = $client->chat([
    ['role' => 'user', "content" => "Hello, Claude"],
    ['role' => 'assistant', "content" => "Hello! It's nice to meet you. How can I assist you today?"],
    ['role' => 'user', "content" => "What is the population of Sydney?"],
]);

echo "Claude's response: " . $response->getContent()[0]['text'];
```

4. Specify a model or max tokens (optional):

```
$response = $client->chat([
    'model' => 'claude-3-opus-20240229',
    'maxTokens' => 1024,
    'messages' => [
        ['role' => 'user', "content" => "Hello, Claude"],
    ]
]);

echo "Claude's response: " . $response->getContent()[0]['text'];
```

The `chat` method is flexible and can handle various input formats, making it easy to interact with Claude in different scenarios.

### Streaming

[](#streaming)

#### Stream with text message

[](#stream-with-text-message)

```
$client->streamMessage('Hello, how are you?', function ($chunk) {
    echo $chunk;
});
```

#### Stream with Array

[](#stream-with-array)

```
$client->streamMessage([
    ['role' => 'user', "content" => "Hello, Claude"],
    ['role' => 'assistant', "content" => "Hello! It's nice to meet you. How can I assist you today?"],
    ['role' => 'user', "content" => "What is the population of Sydney?"],
], function ($chunk) {
    echo $chunk;
});
```

### OpenAI

[](#openai)

There is only limited support for OpenAI API for Chat Completion and Streaming.

```
use Claude\Claude3Api\Config;
use Claude\Claude3Api\Client;

$apiKey = 'sk-#############################';  // OpenAI API Key

$config = new Config($apiKey);
$config->useOpenAI();
$client = new Client($config);

$response = $client->chat("Hello, OpenAI");

echo "OpenAI's response: " . $response->getChoices()[0]['message']['content'];
```

### DeepSeek

[](#deepseek)

There is only limited support for DeepSeek API for Chat Completion and Streaming.

```
use Claude\Claude3Api\Config;
use Claude\Claude3Api\Client;

$apiKey = 'sk-#############################';  // DeepSeek API Key

$config = new Config($apiKey);
$config->useDeepSeek();
$client = new Client($config);

$response = $client->chat("Hello, DeepSeek");

echo "DeepSeek's response: " . $response->getChoices()[0]['message']['content'];
```

### Other Compatible Providers

[](#other-compatible-providers)

There is the flexibility to use other providers, but the API is not fully supported.

```
use Claude\Claude3Api\Config;
use Claude\Claude3Api\Client;

$apiKey = 'sk-#############################';  // Other API Key
$baseUrl = 'https://api.deepseek.com';
$apiVersion = '2023-06-01';
$model = 'deepseek-chat';
$authType = Config::AUTH_TYPE_BEARER; // or Config::AUTH_TYPE_API_KEY
$messagePath = '/chat/completions';
$maxTokens = 8192;

$config = new Config($apiKey, $apiVersion, $baseUrl, $model, $maxTokens, $authType, $messagePath);
$client = new Client($config);

$response = $client->chat("Hello, Other Provider");

echo "Other Provider's response: " . $response->getChoices()[0]['message']['content'];
```

### Advanced Usage

[](#advanced-usage)

For more complex scenarios, you can still use the `sendMessage` method with a `MessageRequest` object:

```
use Claude\Claude3Api\Models\Message;
use Claude\Claude3Api\Models\Content\TextContent;
use Claude\Claude3Api\Requests\MessageRequest;

// Create a message request
$messageRequest = new MessageRequest();

// Add a user message
$userMessage = new Message('user', [
    new TextContent('What is the capital of France?')
]);
$messageRequest->addMessage($userMessage);

// Send the message and get the response
$response = $client->sendMessage($messageRequest);

// Process the response
echo "Claude's response: " . $response->getContent()[0]['text'];
```

### Vision Capabilities

[](#vision-capabilities)

```
use Claude\Claude3Api\Models\Content\ImageContent;

// Send a message with both image and text
$response = $client->sendMessageWithImage('path/to/image.jpg', 'What is in this image?');

echo "Claude's description: " . $response->getContent()[0]['text'];
```

#### Stream with MessageRequest

[](#stream-with-messagerequest)

```
$client->streamMessage($messageRequest, function ($chunk) {
    if ($chunk instanceof MessageResponse) {
        // Handle complete message response
    } elseif (is_array($chunk) && isset($chunk['delta']['text'])) {
        echo $chunk['delta']['text'];
    }
});
```

### Using Tools

[](#using-tools)

```
use Claude\Claude3Api\Models\Tool;

$weatherTool = new Tool(
    'get_weather',
    'Get the current weather in a given location',
    [
        'type' => 'object',
        'properties' => [
            'location' => [
                'type' => 'string',
                'description' => 'The city and state, e.g. San Francisco, CA'
            ],
            'unit' => [
                'type' => 'string',
                'enum' => ['celsius', 'fahrenheit'],
                'description' => 'The unit of temperature'
            ]
        ],
        'required' => ['location']
    ]
);

$messageRequest->addTool($weatherTool);

// Create a message request and add the tool
$messageRequest = new MessageRequest();
$messageRequest->addTool($weatherTool);

// Add a user message that might trigger tool use
$userMessage = new Message('user', [
    new TextContent('What\'s the weather like in New York?')
]);
$messageRequest->addMessage($userMessage);

// Send the message
$response = $client->sendMessage($messageRequest);

// The response might include tool use
foreach ($response->getContent() as $content) {
    if ($content['type'] === 'text') {
        echo "Claude's response: " . $content['text'] . "\n";
    } elseif ($content['type'] === 'tool_use') {
        echo "Tool used: " . $content['name'] . "\n";
        echo "Tool input: " . json_encode($content['input']) . "\n";

        // Here you would typically execute the actual tool
        // and send the result back to Claude in a new message
    }
}
```

### Using Prompt Caching

[](#using-prompt-caching)

Prompt caching is a powerful feature that optimizes API usage by allowing resuming from specific prefixes in your prompts, reducing token costs and response times.

```
use Claude\Claude3Api\Models\Message;
use Claude\Claude3Api\Models\Content\TextContent;
use Claude\Claude3Api\Models\Content\CacheControl;
use Claude\Claude3Api\Requests\MessageRequest;

// Create a message request
$messageRequest = new MessageRequest();

// Set system message with cacheable content
$systemMessage = new Message('system', [
    // Regular system instruction
    new TextContent("You are an AI assistant tasked with analyzing literary works."),

    // Large text to be cached (e.g., an entire book)
    TextContent::withEphemeralCache("")
]);

// Add the system message properly
$messageRequest->addSystemMessage($systemMessage);

// Add a user message
$userMessage = new Message('user', [
    new TextContent('Analyze the major themes in Pride and Prejudice.')
]);
$messageRequest->addMessage($userMessage);

// Send the message
$response = $client->sendMessage($messageRequest);

// Check if the cache was created
if ($response->createdCache()) {
    echo "Created a new cache entry with " . $response->getCacheCreationInputTokens() . " tokens\n";
}

// Process the response
echo "Claude's response: " . $response->getContent()[0]['text'] . "\n";

// --- Send a second request using the same cached content ---

// Create a new message request (the cache will be used automatically)
$messageRequest2 = new MessageRequest();

// Set the exact same system message with the same cache control
$systemMessage2 = new Message('system', [
    new TextContent("You are an AI assistant tasked with analyzing literary works."),
    TextContent::withEphemeralCache("")
]);

// Add the system message properly
$messageRequest2->addSystemMessage($systemMessage2);

// Add a different user message
$userMessage2 = new Message('user', [
    new TextContent('Who is the protagonist in Pride and Prejudice and what are their key characteristics?')
]);
$messageRequest2->addMessage($userMessage2);

// Send the second message
$response2 = $client->sendMessage($messageRequest2);

// Check if the cache was used
if ($response2->usedCache()) {
    echo "Used cache for " . $response2->getCacheReadInputTokens() . " tokens\n";
    echo "Only processed " . $response2->getInputTokens() . " new input tokens\n";
}

// Process the response
echo "Claude's response: " . $response2->getContent()[0]['text'] . "\n";
```

#### Cache Control Methods

[](#cache-control-methods)

The library provides helper methods to work with prompt caching:

```
// Create text content with cache control
$textWithCache = TextContent::withEphemeralCache("Large text to be cached");

// Check cache stats in the response
$response->getCacheCreationInputTokens(); // Tokens written to cache
$response->getCacheReadInputTokens();     // Tokens read from cache
$response->getInputTokens();              // Non-cached tokens
$response->getOutputTokens();             // Output tokens
$response->usedCache();                   // Whether the request used cache
$response->createdCache();                // Whether the request created a cache
```

#### Prompt Caching Requirements

[](#prompt-caching-requirements)

- Supported models: Claude 3.7 Sonnet, Claude 3.5 Sonnet, Claude 3.5 Haiku, Claude 3 Haiku, Claude 3 Opus
- Minimum cacheable prompt length:
    - 1024 tokens for Claude 3.7 Sonnet, Claude 3.5 Sonnet, and Claude 3 Opus
    - 2048 tokens for Claude 3.5 Haiku and Claude 3 Haiku
- The cache has a minimum 5-minute lifetime
- Currently only "ephemeral" cache type is supported

### Using Beta Features

[](#using-beta-features)

The package supports configurable beta features provided by Anthropic's API.

#### 128k Token Output for Claude 3.7 Sonnet

[](#128k-token-output-for-claude-37-sonnet)

Claude 3.7 Sonnet supports an extended output token limit of up to 128k tokens. Here's how to enable it:

```
use Claude\Claude3Api\Config;
use Claude\Claude3Api\Client;

// Method 1: Enable 128k token output with default token setting (131072)
$config = new Config('your-api-key');
$config->enable128kOutputWithTokens();
$client = new Client($config);

// Method 2: Enable 128k token output with custom token limit
$config = new Config('your-api-key');
$config->enable128kOutputWithTokens(100000); // Set to 100k tokens
$client = new Client($config);

// Method 3: Manual configuration
$config = new Config('your-api-key');
$config->enableBetaFeature('output-128k-2025-02-19');
$config->setMaxTokens(131072);
$client = new Client($config);

// Use the client with extended output capacity
$response = $client->chat("Generate a comprehensive report on...");
```

This feature is particularly useful for generating or processing large amounts of content in a single API call.

Testing
-------

[](#testing)

```
composer test
```

Contributing
------------

[](#contributing)

Contributions are welcome! Please feel free to submit a Pull Request.

Maintainer
----------

[](#maintainer)

This package is maintained by [Dale Hurley](https://dalehurley.com).

### Support Dale's Work

[](#support-dales-work)

You can support Dale by checking out his other solutions:

- [Full.CX](https://full.cx) - Transform your product vision into actionable dev tasks with AI-powered clarity and precision
- [Custom Homework Maker](https://customhomeworkmaker.com) - Create engaging, personalized homework assignments in seconds with advanced AI technology
- [SpeedBrain](https://speedbrain.app) - Challenge yourself with this addictive, fast-paced knowledge game - completely free!
- [Spotfillr](https://spotfillr.com) - The smart solution for childcare centers to maximize occupancy and revenue through automated casual spot management
- [1-to-5 App](https://www.1to5app.com) - Help your children develop emotional intelligence with this engaging, research-backed emotional learning companion
- [RapidReportCard](https://rapidreportcard.com) - Streamline performance reviews and unlock your team's full potential with AI-powered insights
- [Risks.io](https://www.risks.io) - Stay ahead of project risks with our intelligent platform for seamless risk management and mitigation
- [TimeLodge](https://timelodge.com) - Simplify your business with powerful time tracking, professional invoicing, and seamless payment processing
- [ToolNames](https://toolnames.com) - Tools and calculators for everything.

License
-------

[](#license)

This Claude 3 API Package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

Support
-------

[](#support)

If you encounter any problems or have any questions, please open an issue in the GitHub repository.

Disclaimer
----------

[](#disclaimer)

This package is not officially associated with Anthropic. Make sure to comply with Anthropic's terms of service when using this package.

Recent Changes
--------------

[](#recent-changes)

### Version 0.1.24

[](#version-0124)

- Added support for php 8.4

### Version 0.1.23

[](#version-0123)

- Added support for prompt caching
- Added CacheControl model for managing cache settings
- Updated TextContent to support cache\_control parameter
- Added cache-related helper methods to MessageResponse
- Improved documentation with prompt caching examples and best practices

### Version 0.1.22

[](#version-0122)

- Fixed the tests

### Version 0.1.21

[](#version-0121)

- Fixed type inconsistency in Config constructor to support strict types
- Added Composer test command - you can now run tests with `composer test`
- Added comprehensive test suite for new features and strict types compatibility

### Version 0.1.20

[](#version-0120)

- Updated default model to Claude 3.7 Sonnet (`claude-3-7-sonnet-latest`)
- Added support for configurable beta features
- Added support for 128k token output for Claude 3.7 Sonnet
- Added convenience methods to enable beta features:
    - `enable128kOutput()` - Enables 128k token output beta feature
    - `enable128kOutputWithTokens()` - Enables 128k token output and sets max tokens
- Added general beta feature management methods:
    - `enableBetaFeature()` - Enable a specific beta feature
    - `disableBetaFeature()` - Disable a specific beta feature
    - `setBetaFeatures()` - Configure multiple beta features at once
    - `isBetaFeatureEnabled()` - Check if a specific beta feature is enabled
    - `getBetaFeatures()` - Get all configured beta features

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance45

Moderate activity, may be stable

Popularity5

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 77.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

429d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7f2ee9ad6febc72dd8bebae2bc06e4288e192dcf3a83b335c7765aa5e2a9d4a3?d=identicon)[eitqan-hub](/maintainers/eitqan-hub)

---

Top Contributors

[![dalehurley](https://avatars.githubusercontent.com/u/286185?v=4)](https://github.com/dalehurley "dalehurley (35 commits)")[![eitqan-hub](https://avatars.githubusercontent.com/u/185493381?v=4)](https://github.com/eitqan-hub "eitqan-hub (6 commits)")[![absoluteweb](https://avatars.githubusercontent.com/u/1394530?v=4)](https://github.com/absoluteweb "absoluteweb (2 commits)")[![evil1morty](https://avatars.githubusercontent.com/u/42971559?v=4)](https://github.com/evil1morty "evil1morty (1 commits)")[![mennovanhout](https://avatars.githubusercontent.com/u/26040589?v=4)](https://github.com/mennovanhout "mennovanhout (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/eitqan-hub-claude-3-api/health.svg)

```
[![Health](https://phpackages.com/badges/eitqan-hub-claude-3-api/health.svg)](https://phpackages.com/packages/eitqan-hub-claude-3-api)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)