Anthropic 10.0.1

Anthropic C# API Library

📦 Package Versioning Update

As of version 10+, the Anthropic package is now the official Anthropic SDK for C# (currently in beta).

Package versions 3.X and below were previously used for the tryAGI community-built SDK, which has moved to tryAGI.Anthropic. If you need to continue using the former client in your project, please update your package reference to tryAGI.Anthropic.

We're grateful to the maintainers of tryAGI.Anthropic for their work serving the Claude ecosystem and C# community.

ℹ️ Beta Release

The Anthropic C# API Library is currently in beta and we're excited for you to experiment with it!

Important: While this package is versioned as 10.0+ due to the package transition described above, it should be treated as an early beta release. This library has not yet been exhaustively tested in production environments and may be missing some features you'd expect in a stable release. There may be breaking changes as we continue development.

We'd love your feedback! Please share any suggestions, bug reports, feature requests, or general thoughts by filing an issue.

The Anthropic C# SDK provides convenient access to the Anthropic REST API from applications written in C#.

The REST API documentation can be found on docs.anthropic.com.

Installation

dotnet add package Anthropic

Requirements

This library requires .NET 8 or later.

Usage

See the examples directory for complete and runnable examples.

using System;
using Anthropic;
using Anthropic.Models.Messages;

AnthropicClient client = new();

MessageCreateParams parameters = new()
{
    MaxTokens = 1024,
    Messages =
    [
        new()
        {
            Role = Role.User,
            Content = "Hello, Claude",
        },
    ],
    Model = Model.Claude3_7SonnetLatest,
};

var message = await client.Messages.Create(parameters);

Console.WriteLine(message);

Client configuration

Configure the client using environment variables:

using Anthropic;

// Configured using the ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN and ANTHROPIC_BASE_URL environment variables
AnthropicClient client = new();

Or manually:

using Anthropic;

AnthropicClient client = new() { APIKey = "my-anthropic-api-key" };

Or using a combination of the two approaches.

See this table for the available options:

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call WithOptions on any client or service:

using System;

var message = await client
    .WithOptions(options =>
        options with
        {
            BaseUrl = new("https://example.com"),
            Timeout = TimeSpan.FromSeconds(42),
        }
    )
    .Messages.Create(parameters);

Console.WriteLine(message);

Using a with expression makes it easy to construct the modified options.

The WithOptions method does not affect the original client or service.

Requests and responses

To send a request to the Anthropic API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a C# class.

For example, client.Messages.Create should be called with an instance of MessageCreateParams, and it will return an instance of Task<Message>.

Streaming

The SDK defines methods that return response "chunk" streams, where each chunk can be individually processed as soon as it arrives instead of waiting on the full response. Streaming methods generally correspond to SSE or JSONL responses.

Some of these methods may have streaming and non-streaming variants, but a streaming method will always have a Streaming suffix in its name, even if it doesn't have a non-streaming variant.

These streaming methods return IAsyncEnumerable:

using System;
using Anthropic.Models.Messages;

MessageCreateParams parameters = new()
{
    MaxTokens = 1024,
    Messages =
    [
        new()
        {
            Role = Role.User,
            Content = "Hello, Claude",
        },
    ],
    Model = Model.Claude3_7SonnetLatest,
};

await foreach (var message in client.Messages.CreateStreaming(parameters))
{
    Console.WriteLine(message);
}

Binary responses

The SDK defines methods that return binary responses, which are used for API responses that shouldn't necessarily be parsed, like non-JSON data.

These methods return HttpResponse:

using System;
using Anthropic.Models.Beta.Files;

FileDownloadParams parameters = new() { FileID = "file_id" };

var response = await client.Beta.Files.Download(parameters);

Console.WriteLine(response);

To save the response content to a file, or any Stream, use the CopyToAsync method:

using System.IO;

using var response = await client.Beta.Files.Download(parameters);
using var contentStream = await response.ReadAsStream();
using var fileStream = File.Open(path, FileMode.OpenOrCreate);
await contentStream.CopyToAsync(fileStream); // Or any other Stream

Error handling

The SDK throws custom unchecked exception types:

• AnthropicApiException: Base class for API errors. See this table for which exception subclass is thrown for each HTTP status code:

Additionally, all 4xx errors inherit from Anthropic4xxException.

• AnthropicSseException: thrown for errors encountered during SSE streaming after a successful initial HTTP response.

• AnthropicIOException: I/O networking errors.

• AnthropicInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• AnthropicException: Base class for all exceptions.

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff between requests.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a request.

To set a custom number of retries, configure the client using the MaxRetries method:

using Anthropic;

AnthropicClient client = new() { MaxRetries = 3 };

Or configure a single method call using WithOptions:

using System;

var message = await client
    .WithOptions(options =>
        options with { MaxRetries = 3 }
    )
    .Messages.Create(parameters);

Console.WriteLine(message);

Timeouts

Requests time out after 10 minutes by default.

To set a custom timeout, configure the client using the Timeout option:

using System;
using Anthropic;

AnthropicClient client = new() { Timeout = TimeSpan.FromSeconds(42) };

Or configure a single method call using WithOptions:

using System;

var message = await client
    .WithOptions(options =>
        options with { Timeout = TimeSpan.FromSeconds(42) }
    )
    .Messages.Create(parameters);

Console.WriteLine(message);

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a string, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw AnthropicInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call Validate:

var message = client.Messages.Create(parameters);
message.Validate();

Or configure the client using the ResponseValidation option:

using Anthropic;

AnthropicClient client = new() { ResponseValidation = true };

Or configure a single method call using WithOptions:

using System;

var message = await client
    .WithOptions(options =>
        options with { ResponseValidation = true }
    )
    .Messages.Create(parameters);

Console.WriteLine(message);

Semantic versioning

⚠️ Beta Release: While this package is versioned as 10+, it is currently in beta. During the beta period, breaking changes may occur in minor or patch releases. Once the library reaches stable release, we will follow SemVer conventions more strictly.

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.