El SDK de C# de Anthropic proporciona acceso conveniente a la API REST de Anthropic desde aplicaciones escritas en C#.
El SDK de C# se encuentra actualmente en beta. Las APIs pueden cambiar entre versiones.
Para la documentación de las funciones de la API con ejemplos de código, consulta la referencia de la API. Esta página cubre las funciones y la configuración del SDK específicas de C#.
A partir de la versión 10+, el paquete Anthropic es ahora el SDK oficial de Anthropic para C#. Las versiones 3.X y anteriores del paquete se usaban previamente para el SDK construido por la comunidad tryAGI, que se ha movido a tryAGI.Anthropic. Si necesitas seguir usando el cliente anterior en tu proyecto, actualiza tu referencia de paquete a tryAGI.Anthropic.
Instala el paquete desde NuGet:
dotnet add package AnthropicEsta biblioteca requiere .NET Standard 2.0 o posterior.
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.ClaudeOpus5,
};
var message = await client.Messages.Create(parameters);
foreach (var block in message.Content)
{
if (block.TryPickText(out var textBlock))
{
Console.WriteLine(textBlock.Text);
}
}Para conocer las opciones de autenticación, incluida Workload Identity Federation, consulta Autenticación.
Configura el cliente usando variables de entorno:
using Anthropic;
// Se configura usando las variables de entorno ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN y ANTHROPIC_BASE_URL
AnthropicClient client = new();O manualmente:
using Anthropic;
AnthropicClient client = new() { ApiKey = "my-anthropic-api-key" };O usando una combinación de ambos enfoques.
Consulta esta tabla para ver las opciones disponibles:
| Propiedad | Variable de entorno | Requerido | Valor predeterminado |
|---|---|---|---|
ApiKey | ANTHROPIC_API_KEY | false | - |
AuthToken | ANTHROPIC_AUTH_TOKEN | false | - |
BaseUrl | ANTHROPIC_BASE_URL | true | "https://api.anthropic.com" |
Para usar temporalmente una configuración de cliente modificada, mientras se reutilizan la misma conexión y los mismos grupos de hilos, llama a WithOptions en cualquier cliente o servicio:
using System;
var message = await client
.WithOptions(options =>
options with
{
BaseUrl = "https://example.com",
Timeout = TimeSpan.FromSeconds(42),
}
)
.Messages.Create(parameters);
Console.WriteLine(message);Usar una expresión with facilita la construcción de las opciones modificadas.
El método WithOptions no afecta al cliente o servicio original.
El SDK define métodos que devuelven flujos de "chunks" (fragmentos) de respuesta, donde cada fragmento puede procesarse individualmente tan pronto como llega en lugar de esperar la respuesta completa. Los métodos de streaming generalmente corresponden a respuestas SSE o JSONL.
Un método de streaming siempre tiene el sufijo Streaming en su nombre, incluso si no tiene una variante sin streaming.
Estos métodos de streaming devuelven IAsyncEnumerable:
using System;
using Anthropic.Models.Messages;
MessageCreateParams parameters = new()
{
MaxTokens = 1024,
Messages =
[
new()
{
Role = Role.User,
Content = "Hello, Claude",
},
],
Model = Model.ClaudeOpus5,
};
await foreach (var message in client.Messages.CreateStreaming(parameters))
{
Console.WriteLine(message);
}El SDK lanza tipos de excepciones personalizadas no verificadas:
AnthropicApiException: Clase base para errores de la API. Consulta esta tabla para ver qué subclase de excepción se lanza para cada código de estado HTTP:| Estado | Excepción |
|---|---|
| 400 | AnthropicBadRequestException |
| 401 | AnthropicUnauthorizedException |
| 403 | AnthropicForbiddenException |
| 404 | AnthropicNotFoundException |
| 422 | AnthropicUnprocessableEntityException |
| 429 | AnthropicRateLimitException |
| 5xx | Anthropic5xxException |
| otros | AnthropicUnexpectedStatusCodeException |
Además, todos los errores 4xx heredan de Anthropic4xxException.
AnthropicSseException: se lanza para errores encontrados durante el streaming SSE después de una respuesta HTTP inicial exitosa.
AnthropicIOException: errores de red de E/S.
AnthropicInvalidDataException: Fallo al interpretar datos analizados correctamente. Por ejemplo, al acceder a una propiedad que se supone que es requerida, pero que la API omitió inesperadamente de la respuesta.
AnthropicException: Clase base para todas las excepciones.
El SDK reintenta automáticamente 2 veces de forma predeterminada, con un breve retroceso exponencial entre solicitudes.
Solo se reintentan los siguientes tipos de errores:
La API también puede indicar explícitamente al SDK que reintente o no reintente una solicitud.
Para establecer un número personalizado de reintentos, configura el cliente usando la propiedad MaxRetries:
using Anthropic;
AnthropicClient client = new() { MaxRetries = 3 };O configura una sola llamada a método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { MaxRetries = 3 }
)
.Messages.Create(parameters);
Console.WriteLine(message);Las solicitudes expiran después de 10 minutos de forma predeterminada.
Para establecer un tiempo de espera personalizado, configura el cliente usando la opción Timeout:
using System;
using Anthropic;
AnthropicClient client = new() { Timeout = TimeSpan.FromSeconds(42) };O configura una sola llamada a método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { Timeout = TimeSpan.FromSeconds(42) }
)
.Messages.Create(parameters);
Console.WriteLine(message);El SDK define métodos que devuelven listas paginadas de resultados. Proporciona formas convenientes de acceder a los resultados, ya sea una página a la vez o elemento por elemento a través de todas las páginas.
Para iterar a través de todos los resultados en todas las páginas, usa el método Paginate, que obtiene automáticamente más páginas según sea necesario. El método devuelve un IAsyncEnumerable:
using System;
var page = await client.Messages.Batches.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}Para acceder a los elementos de páginas individuales y solicitar manualmente la siguiente página, usa la propiedad Items, y los métodos HasNext y Next:
var page = await client.Messages.Batches.List();
while (true)
{
foreach (var item in page.Items)
{
Console.WriteLine(item);
}
if (!page.HasNext())
{
break;
}
page = await page.Next();
}En casos raros, la API puede devolver una respuesta que no coincide con el tipo esperado. De forma predeterminada, el SDK no lanza una excepción en este caso. Lanza AnthropicInvalidDataException solo si accedes directamente a la propiedad.
Si prefieres verificar de antemano que la respuesta está completamente bien tipada, entonces llama a Validate:
var message = await client.Messages.Create(parameters);
message.Validate();O configura el cliente usando la opción ResponseValidation:
using Anthropic;
AnthropicClient client = new() { ResponseValidation = true };O configura una sola llamada a método usando WithOptions:
using System;
var message = await client
.WithOptions(options =>
options with { ResponseValidation = true }
)
.Messages.Create(parameters);
Console.WriteLine(message);El SDK proporciona una implementación de la interfaz IChatClient de la biblioteca Microsoft.Extensions.AI.Abstractions. Esto permite que AnthropicClient (y Anthropic.Services.IBetaService) se usen con otras bibliotecas que se integran con estas abstracciones centrales. Por ejemplo, las herramientas de la biblioteca MCP C# SDK (ModelContextProtocol) se pueden usar directamente con un AnthropicClient expuesto a través de IChatClient.
using Anthropic;
using Microsoft.Extensions.AI;
using ModelContextProtocol.Client;
// Configurado usando las variables de entorno ANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN y ANTHROPIC_BASE_URL
AnthropicClient client = new();
IChatClient chatClient = client.AsIChatClient("claude-opus-5")
.AsBuilder()
.UseFunctionInvocation()
.Build();
// Usando McpClient del SDK de C# de MCP
McpClient learningServer = await McpClient.CreateAsync(
new HttpClientTransport(new() { Endpoint = new("https://learn.microsoft.com/api/mcp") }));
ChatOptions options = new() { Tools = [.. await learningServer.ListToolsAsync()] };
Console.WriteLine(await chatClient.GetResponseAsync("Tell me about IChatClient", options));Para enviar una solicitud a la API de Claude, construye una instancia de una clase Params y pásala al método del cliente correspondiente. Cuando se recibe la respuesta, se deserializa en una instancia de una clase de C#.
Por ejemplo, client.Messages.Create debe llamarse con una instancia de MessageCreateParams, y devolverá una instancia de Task<Message>.
El SDK define métodos que devuelven respuestas binarias, que se usan para respuestas de la API que no necesariamente deben analizarse, como datos que no son JSON.
Estos métodos devuelven 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);Para guardar el contenido de la respuesta en un archivo, o en cualquier Stream, usa el método CopyToAsync:
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 StreamEl SDK define métodos que deserializan las respuestas en instancias de clases de C#. Para acceder a los encabezados de la respuesta, el código de estado o el cuerpo de la respuesta sin procesar, antepón WithRawResponse a cualquier llamada de método HTTP en un cliente o servicio:
var response = await client.WithRawResponse.Messages.Create(parameters);
var statusCode = response.StatusCode;
var headers = response.Headers;También se puede acceder al HttpResponseMessage sin procesar a través de la propiedad RawMessage.
Para respuestas sin streaming, puedes deserializar la respuesta en una instancia de una clase de C# si es necesario:
using System;
using Anthropic.Models.Messages;
var response = await client.WithRawResponse.Messages.Create(parameters);
Message deserialized = await response.Deserialize();
Console.WriteLine(deserialized);Para respuestas con streaming, puedes deserializar la respuesta a un IAsyncEnumerable si es necesario:
using System;
var response = await client.WithRawResponse.Messages.CreateStreaming(parameters);
await foreach (var item in response.Enumerate())
{
Console.WriteLine(item);
}Todos los mensajes de log están destinados únicamente a la depuración. El formato y el contenido de los mensajes de log pueden cambiar entre versiones.
Habilita el registro de depuración estableciendo una variable de entorno:
export ANTHROPIC_LOG=debugEl SDK está tipado para un uso conveniente de la API documentada. Sin embargo, también admite trabajar con partes de la API no documentadas o aún no compatibles.
Para guías detalladas de configuración de plataformas con ejemplos de código, consulta:
El SDK de C# admite las siguientes plataformas a través de paquetes NuGet separados:
Anthropic.Vertex. Consulta Claude en Google Cloud para la configuración del cliente.Anthropic.Bedrock. Usa AnthropicBedrockMantleClient para el endpoint de Bedrock de la Messages-API, o AnthropicBedrockClient (ruta bedrock-runtime). AnthropicBedrockMantleClient acepta un objeto de configuración opcional MantleAwsClientOptions; AnthropicBedrockClient acepta AnthropicBedrockCredentialsHelper.FromEnv() o credenciales explícitas.Anthropic.Aws. Usa AnthropicAwsClient; establece WorkspaceId en el cliente o la variable de entorno ANTHROPIC_AWS_WORKSPACE_ID (consulta Workspaces). Disponible en beta.Anthropic.Foundry. Usa AnthropicFoundryClient con DefaultAnthropicFoundryCredentials.FromEnv() o credenciales explícitas.Usa AnthropicBedrockMantleClient para proyectos nuevos; AnthropicBedrockClient permanece para aplicaciones existentes que usan la API InvokeModel de Bedrock.
Aunque este paquete está versionado como 10+, actualmente se encuentra en beta. Durante el período beta, pueden ocurrir cambios incompatibles en versiones menores o de parche. Una vez que la biblioteca alcance una versión estable, las convenciones de SemVer se seguirán de manera más estricta. Comparte tus comentarios creando un issue.
Este paquete generalmente sigue las convenciones de SemVer, aunque ciertos cambios incompatibles con versiones anteriores pueden publicarse como versiones menores:
La compatibilidad con versiones anteriores se toma en serio para garantizar que puedas confiar en una experiencia de actualización fluida.
Was this page helpful?