AnthropicClient.ts overview
Since v1.0.0
Exports Grouped by Category
- Constructors
- Context
- Layers
- Models
- Schemas
- CitationsDelta (class)
- ContentBlockDeltaEvent (class)
- ContentBlockStartEvent (class)
- ContentBlockStopEvent (class)
- ErrorEvent (class)
- InputJsonContentBlockDelta (class)
- MessageDelta (class)
- MessageDeltaEvent (class)
- MessageDeltaUsage (class)
- MessageStartEvent (class)
- MessageStopEvent (class)
- MessageStreamEvent
- PingEvent (class)
- ServerToolUsage (class)
- SignatureContentBlockDelta (class)
- TextContentBlockDelta (class)
- ThinkingContentBlockDelta (class)
Constructors
make
Signature
declare const make: (options: {
readonly apiKey?: Redacted.Redacted | undefined
readonly apiUrl?: string | undefined
readonly anthropicVersion?: string | undefined
readonly organizationId?: Redacted.Redacted | undefined
readonly projectId?: Redacted.Redacted | undefined
readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined
}) => Effect.Effect<Service, never, HttpClient.HttpClient | Scope.Scope>
Since v1.0.0
Context
AnthropicClient (class)
Signature
declare class AnthropicClient
Since v1.0.0
Layers
layer
Signature
declare const layer: (options: {
readonly apiKey?: Redacted.Redacted | undefined
readonly apiUrl?: string | undefined
readonly anthropicVersion?: string | undefined
readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined
}) => Layer.Layer<AnthropicClient, never, HttpClient.HttpClient>
Since v1.0.0
layerConfig
Signature
declare const layerConfig: (options: {
readonly apiKey?: Config.Config<Redacted.Redacted | undefined> | undefined
readonly apiUrl?: Config.Config<string | undefined> | undefined
readonly anthropicVersion?: Config.Config<string | undefined> | undefined
readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined
}) => Layer.Layer<AnthropicClient, ConfigError, HttpClient.HttpClient>
Since v1.0.0
Models
MessageStreamEvent (type alias)
Signature
type MessageStreamEvent = typeof MessageStreamEvent.Type
Since v1.0.0
Service (interface)
Represents the interface that the AnthropicClient
service provides.
This service abstracts the complexity of communicating with Anthropic’s API, providing both high-level text generation methods and low-level HTTP access for advanced use cases.
Signature
export interface Service {
/**
* The underlying HTTP client capable of communicating with the Anthropic API.
*
* This client is pre-configured with authentication, base URL, and standard
* headers required for Anthropic API communication. It provides direct access
* to the generated Anthropic API client for operations not covered by the
* higher-level methods.
*
* Use this when you need to:
* - Access provider-specific API endpoints not available through the AI SDK
* - Implement custom request/response handling
* - Use Anthropic API features not yet supported by the Effect AI abstractions
* - Perform batch operations or non-streaming requests
*
* The client automatically handles authentication and follows Anthropic's
* API conventions for request formatting and error handling.
*/
readonly client: Generated.Client
readonly streamRequest: <A, I, R>(
request: HttpClientRequest.HttpClientRequest,
schema: Schema.Schema<A, I, R>
) => Stream.Stream<A, AiError.AiError, R>
readonly createMessage: (options: {
readonly params?: typeof Generated.BetaMessagesPostParams.Encoded | undefined
readonly payload: typeof Generated.BetaCreateMessageParams.Encoded
}) => Effect.Effect<Generated.BetaMessage, AiError.AiError>
readonly createMessageStream: (options: {
readonly params?: typeof Generated.BetaMessagesPostParams.Encoded | undefined
readonly payload: Omit<typeof Generated.BetaCreateMessageParams.Encoded, "stream">
}) => Stream.Stream<MessageStreamEvent, AiError.AiError>
}
Since v1.0.0
Schemas
CitationsDelta (class)
Signature
declare class CitationsDelta
Since v1.0.0
ContentBlockDeltaEvent (class)
Signature
declare class ContentBlockDeltaEvent
Since v1.0.0
ContentBlockStartEvent (class)
Signature
declare class ContentBlockStartEvent
Since v1.0.0
ContentBlockStopEvent (class)
Signature
declare class ContentBlockStopEvent
Since v1.0.0
ErrorEvent (class)
Signature
declare class ErrorEvent
Since v1.0.0
InputJsonContentBlockDelta (class)
Signature
declare class InputJsonContentBlockDelta
Since v1.0.0
MessageDelta (class)
Signature
declare class MessageDelta
Since v1.0.0
MessageDeltaEvent (class)
Signature
declare class MessageDeltaEvent
Since v1.0.0
MessageDeltaUsage (class)
Signature
declare class MessageDeltaUsage
Since v1.0.0
MessageStartEvent (class)
Signature
declare class MessageStartEvent
Since v1.0.0
MessageStopEvent (class)
Signature
declare class MessageStopEvent
Since v1.0.0
MessageStreamEvent
Signature
declare const MessageStreamEvent: Schema.Union<
[
typeof PingEvent,
typeof ErrorEvent,
typeof MessageStartEvent,
typeof MessageDeltaEvent,
typeof MessageStopEvent,
typeof ContentBlockStartEvent,
typeof ContentBlockDeltaEvent,
typeof ContentBlockStopEvent
]
>
Since v1.0.0
PingEvent (class)
Signature
declare class PingEvent
Since v1.0.0
ServerToolUsage (class)
Signature
declare class ServerToolUsage
Since v1.0.0
SignatureContentBlockDelta (class)
Signature
declare class SignatureContentBlockDelta
Since v1.0.0
TextContentBlockDelta (class)
Signature
declare class TextContentBlockDelta
Since v1.0.0
ThinkingContentBlockDelta (class)
Signature
declare class ThinkingContentBlockDelta
Since v1.0.0