openrouter

package module

Go to main page

Versions in this module

v1

v1.8.1

Jun 7, 2026

Changes in this version

type CompletionTokensDetails

+ AudioTokens int

+ ImageTokens int

type CostDetails

+ UpstreamInferenceCompletionsCost *float64

+ UpstreamInferencePromptCost *float64

type PromptTokensDetails

+ AudioTokens int

+ CacheWriteTokens int

+ VideoTokens int

type Usage

+ IsBYOK bool

v1.8.0

Jun 7, 2026

Changes in this version

type ChatCompletionOption

+ func WithUsage(include bool) ChatCompletionOption

type ChatCompletionRequest

+ Usage *UsageRequest

type CompletionOption

+ func WithCompletionUsage(include bool) CompletionOption

type CompletionRequest

+ Usage *UsageRequest

+ type CompletionTokensDetails struct

+ ReasoningTokens int

+ type CostDetails struct

+ UpstreamInferenceCost *float64

+ type PromptTokensDetails struct

+ CachedTokens int

type Usage

+ CompletionTokensDetails *CompletionTokensDetails

+ Cost *float64

+ CostDetails *CostDetails

+ PromptTokensDetails *PromptTokensDetails

+ type UsageRequest struct

+ Include bool

v1.7.0

Apr 24, 2026

Changes in this version

+ const SpeechFormatMP3

+ const SpeechFormatPCM

+ type BulkAddWorkspaceMembersResponse struct

+ AddedCount int

+ Data []WorkspaceMember

+ type BulkRemoveWorkspaceMembersResponse struct

+ RemovedCount int

type Client

+ func (c *Client) AddWorkspaceMembers(ctx context.Context, idOrSlug string, userIDs []string) (*BulkAddWorkspaceMembersResponse, error)

+ func (c *Client) CreateSpeech(ctx context.Context, input, model, voice string, opts ...SpeechOption) (*SpeechResponse, error)

+ func (c *Client) CreateVideo(ctx context.Context, model, prompt string, opts ...VideoGenerationOption) (*VideoGenerationResponse, error)

+ func (c *Client) CreateWorkspace(ctx context.Context, req *CreateWorkspaceRequest) (*CreateWorkspaceResponse, error)

+ func (c *Client) DeleteWorkspace(ctx context.Context, idOrSlug string) (*DeleteWorkspaceResponse, error)

+ func (c *Client) GetVideo(ctx context.Context, jobID string) (*VideoGenerationResponse, error)

+ func (c *Client) GetVideoContent(ctx context.Context, jobID string, index int) (*VideoContentResponse, error)

+ func (c *Client) GetWorkspace(ctx context.Context, idOrSlug string) (*GetWorkspaceResponse, error)

+ func (c *Client) ListOrganizationMembers(ctx context.Context, options *ListOrganizationMembersOptions) (*ListOrganizationMembersResponse, error)

+ func (c *Client) ListVideoModels(ctx context.Context) (*VideoModelsResponse, error)

+ func (c *Client) ListWorkspaces(ctx context.Context, options *ListWorkspacesOptions) (*ListWorkspacesResponse, error)

+ func (c *Client) RemoveWorkspaceMembers(ctx context.Context, idOrSlug string, userIDs []string) (*BulkRemoveWorkspaceMembersResponse, error)

+ func (c *Client) UpdateWorkspace(ctx context.Context, idOrSlug string, req *UpdateWorkspaceRequest) (*UpdateWorkspaceResponse, error)

+ type CreateWorkspaceRequest struct

+ DefaultImageModel *string

+ DefaultProviderSort *string

+ DefaultTextModel *string

+ Description *string

+ IOLoggingAPIKeyIDs *[]int

+ IOLoggingSamplingRate *float64

+ IsDataDiscountLoggingEnabled *bool

+ IsObservabilityBroadcastEnabled *bool

+ IsObservabilityIOLoggingEnabled *bool

+ Name string

+ Slug string

+ type CreateWorkspaceResponse struct

+ Data Workspace

+ type DeleteWorkspaceResponse struct

+ Deleted bool

+ type GetWorkspaceResponse struct

+ Data Workspace

+ type ListOrganizationMembersOptions struct

+ Limit *int

+ Offset *int

+ type ListOrganizationMembersResponse struct

+ Data []OrganizationMember

+ TotalCount int

+ type ListWorkspacesOptions struct

+ Limit *int

+ Offset *int

+ type ListWorkspacesResponse struct

+ Data []Workspace

+ TotalCount int

+ type OrganizationMember struct

+ Email string

+ FirstName *string

+ ID string

+ LastName *string

+ Role OrganizationMemberRole

+ type OrganizationMemberRole string

+ const OrganizationMemberRoleAdmin

+ const OrganizationMemberRoleMember

+ type SpeechOption func(*SpeechRequest)

+ func WithSpeechProviderOptions(provider string, options map[string]any) SpeechOption

+ func WithSpeechResponseFormat(format string) SpeechOption

+ func WithSpeechSpeed(speed float64) SpeechOption

+ type SpeechProvider struct

+ Options map[string]map[string]any

+ type SpeechRequest struct

+ Input string

+ Model string

+ Provider *SpeechProvider

+ ResponseFormat string

+ Speed *float64

+ Voice string

+ type SpeechResponse struct

+ Audio []byte

+ ContentType string

+ Format string

+ type UpdateWorkspaceRequest struct

+ DefaultImageModel *string

+ DefaultProviderSort *string

+ DefaultTextModel *string

+ Description *string

+ IOLoggingAPIKeyIDs *[]int

+ IOLoggingSamplingRate *float64

+ IsDataDiscountLoggingEnabled *bool

+ IsObservabilityBroadcastEnabled *bool

+ IsObservabilityIOLoggingEnabled *bool

+ Name *string

+ Slug *string

+ type UpdateWorkspaceResponse struct

+ Data Workspace

+ type VideoAspectRatio string

+ const VideoAspectRatio16x9

+ const VideoAspectRatio1x1

+ const VideoAspectRatio21x9

+ const VideoAspectRatio3x4

+ const VideoAspectRatio4x3

+ const VideoAspectRatio9x16

+ const VideoAspectRatio9x21

+ type VideoContentPartImage struct

+ ImageURL VideoImageURL

+ Type string

+ type VideoContentResponse struct

+ Content []byte

+ ContentType string

+ type VideoFrameImage struct

+ FrameType VideoFrameType

+ ImageURL VideoImageURL

+ Type string

+ type VideoFrameType string

+ const VideoFrameTypeFirst

+ const VideoFrameTypeLast

+ type VideoGenerationOption func(*VideoGenerationRequest)

+ func WithVideoAspectRatio(ratio VideoAspectRatio) VideoGenerationOption

+ func WithVideoCallbackURL(url string) VideoGenerationOption

+ func WithVideoDuration(seconds int) VideoGenerationOption

+ func WithVideoFrameImages(frames ...VideoFrameImage) VideoGenerationOption

+ func WithVideoGenerateAudio(enabled bool) VideoGenerationOption

+ func WithVideoInputReferences(refs ...VideoContentPartImage) VideoGenerationOption

+ func WithVideoProviderOptions(provider string, options map[string]any) VideoGenerationOption

+ func WithVideoResolution(resolution VideoResolution) VideoGenerationOption

+ func WithVideoSeed(seed int) VideoGenerationOption

+ func WithVideoSize(size string) VideoGenerationOption

+ type VideoGenerationRequest struct

+ AspectRatio VideoAspectRatio

+ CallbackURL string

+ Duration *int

+ FrameImages []VideoFrameImage

+ GenerateAudio *bool

+ InputReferences []VideoContentPartImage

+ Model string

+ Prompt string

+ Provider *VideoProvider

+ Resolution VideoResolution

+ Seed *int

+ Size string

+ type VideoGenerationResponse struct

+ Error string

+ GenerationID string

+ ID string

+ PollingURL string

+ Status VideoStatus

+ UnsignedURLs []string

+ Usage *VideoGenerationUsage

+ type VideoGenerationUsage struct

+ Cost *float64

+ IsBYOK bool

+ type VideoImageURL struct

+ URL string

+ type VideoModel struct

+ AllowedPassthroughParameters []string

+ CanonicalSlug string

+ Created int64

+ Description string

+ GenerateAudio *bool

+ HuggingFaceID *string

+ ID string

+ Name string

+ PricingSKUs map[string]string

+ Seed *bool

+ SupportedAspectRatios []VideoAspectRatio

+ SupportedDurations []int

+ SupportedFrameImages []VideoFrameType

+ SupportedResolutions []VideoResolution

+ SupportedSizes []string

+ type VideoModelsResponse struct

+ Data []VideoModel

+ type VideoProvider struct

+ Options map[string]map[string]any

+ type VideoResolution string

+ const VideoResolution1080p

+ const VideoResolution1K

+ const VideoResolution2K

+ const VideoResolution480p

+ const VideoResolution4K

+ const VideoResolution720p

+ type VideoStatus string

+ const VideoStatusCancelled

+ const VideoStatusCompleted

+ const VideoStatusExpired

+ const VideoStatusFailed

+ const VideoStatusInProgress

+ const VideoStatusPending

+ type Workspace struct

+ CreatedAt string

+ CreatedBy *string

+ DefaultImageModel *string

+ DefaultProviderSort *string

+ DefaultTextModel *string

+ Description *string

+ ID string

+ IOLoggingAPIKeyIDs *[]int

+ IOLoggingSamplingRate float64

+ IsDataDiscountLoggingEnabled bool

+ IsObservabilityBroadcastEnabled bool

+ IsObservabilityIOLoggingEnabled bool

+ Name string

+ Slug string

+ UpdatedAt *string

+ type WorkspaceMember struct

+ CreatedAt string

+ ID string

+ Role WorkspaceMemberRole

+ UserID string

+ WorkspaceID string

+ type WorkspaceMemberRole string

+ const WorkspaceMemberRoleAdmin

+ const WorkspaceMemberRoleMember

v1.6.1

Apr 23, 2026

v1.6.0

Apr 6, 2026

Changes in this version

type Client

+ func (c *Client) Rerank(ctx context.Context, query string, documents []string, model string, ...) (*RerankResponse, error)

+ type RerankDocument struct

+ Text string

+ type RerankOption func(*RerankRequest)

+ func WithRerankAllowFallbacks(allow bool) RerankOption

+ func WithRerankDataCollection(policy string) RerankOption

+ func WithRerankIgnoreProviders(providers ...string) RerankOption

+ func WithRerankOnlyProviders(providers ...string) RerankOption

+ func WithRerankProvider(provider Provider) RerankOption

+ func WithRerankProviderOrder(providers ...string) RerankOption

+ func WithRerankProviderSort(sort string) RerankOption

+ func WithRerankTopN(topN int) RerankOption

+ type RerankRequest struct

+ Documents []string

+ Model string

+ Provider *Provider

+ Query string

+ TopN *int

+ type RerankResponse struct

+ ID string

+ Model string

+ Provider string

+ Results []RerankResult

+ Usage *RerankUsage

+ type RerankResult struct

+ Document RerankDocument

+ Index int

+ RelevanceScore float64

+ type RerankUsage struct

+ Cost *float64

+ SearchUnits int

+ TotalTokens int

v1.5.2

Mar 1, 2026

Changes in this version

type BroadcastTrace

+ APIKeyName string

+ AudioInputTokens int

+ CachedTokens int

+ Completion string

+ EntityID string

+ FinishReason string

+ FinishReasons string

+ ImageOutputTokens int

+ InputCost float64

+ InputTokens int

+ InputUnitPrice float64

+ OpenRouterFinishReason string

+ OpenRouterProviderName string

+ OpenRouterUserID string

+ OperationName string

+ OutputCost float64

+ OutputTokens int

+ OutputUnitPrice float64

+ Prompt string

+ ProviderName string

+ ProviderSlug string

+ ReasoningTokens int

+ RequestModel string

+ ResponseModel string

+ Source string

+ SpanInput string

+ SpanLevel string

+ SpanMetadata map[string]string

+ SpanOutput string

+ SpanType string

+ System string

+ TotalCost float64

+ TraceInput string

+ TraceName string

+ TraceOutput string

+ TraceTags string

+ VideoInputTokens int

v1.5.1

Feb 28, 2026

Changes in this version

+ type FlexInt string

+ func (f *FlexInt) UnmarshalJSON(data []byte) error

+ func (f FlexInt) MarshalJSON() ([]byte, error)

+ func (f FlexInt) String() string

v1.5.0

Feb 26, 2026

Changes in this version

+ const AnthropicContentTypeDocument

+ const AnthropicContentTypeImage

+ const AnthropicContentTypeRedactedThinking

+ const AnthropicContentTypeText

+ const AnthropicContentTypeThinking

+ const AnthropicContentTypeToolResult

+ const AnthropicContentTypeToolUse

+ const AnthropicServiceTierAuto

+ const AnthropicServiceTierStandard

+ const AnthropicSourceBase64

+ const AnthropicSourceURL

+ const AnthropicStopReasonEndTurn

+ const AnthropicStopReasonMaxTokens

+ const AnthropicStopReasonStopSequence

+ const AnthropicStopReasonToolUse

+ const AnthropicThinkingDisabled

+ const AnthropicThinkingEnabled

+ const AnthropicToolChoiceAny

+ const AnthropicToolChoiceAuto

+ const AnthropicToolChoiceNone

+ const AnthropicToolChoiceTool

+ var ErrAnthropicMaxTokensRequired = &ValidationError

+ var ErrNoAnthropicMessages = &ValidationError

+ func BroadcastWebhookHandler(callback func([]BroadcastTrace)) http.HandlerFunc

+ func BroadcastWebhookHandlerWithError(callback func([]BroadcastTrace) error) http.HandlerFunc

+ func BuildAuthURL(baseURL string, params AuthURLParams) (string, error)

+ func CreateS256CodeChallenge(verifier string) string

+ func EndpointSupportsParameter(params []string, param string) bool

+ func GenerateCodeVerifier() (string, error)

+ func ParsePricing(priceStr string) float64

+ func ParsePricingPtr(priceStr *string) float64

+ type AnthropicCitation struct

+ CitedText string

+ DocumentIndex *int

+ DocumentTitle string

+ EndBlockIndex *int

+ EndCharIndex *int

+ EndPageNumber *int

+ StartBlockIndex *int

+ StartCharIndex *int

+ StartPageNumber *int

+ Title string

+ Type string

+ URL string

+ type AnthropicCitationsConfig struct

+ Enabled bool

+ type AnthropicContentBlock struct

+ Citations *AnthropicCitationsConfig

+ Data string

+ ID string

+ Input json.RawMessage

+ IsError *bool

+ Name string

+ Signature string

+ Source *AnthropicContentSource

+ Text string

+ Thinking string

+ ToolResultContent any

+ ToolUseID string

+ Type string

+ func CreateAnthropicDocumentBase64Block(mediaType string, data string) AnthropicContentBlock

+ func CreateAnthropicDocumentURLBlock(url string) AnthropicContentBlock

+ func CreateAnthropicImageBase64Block(mediaType string, data string) AnthropicContentBlock

+ func CreateAnthropicImageURLBlock(url string) AnthropicContentBlock

+ func CreateAnthropicTextBlock(text string) AnthropicContentBlock

+ func CreateAnthropicToolResultBlock(toolUseID string, content string) AnthropicContentBlock

+ func CreateAnthropicToolUseBlock(id, name string, input json.RawMessage) AnthropicContentBlock

+ type AnthropicContentSource struct

+ Data string

+ MediaType string

+ Type string

+ URL string

+ type AnthropicMessage struct

+ Content any

+ Role string

+ func CreateAnthropicAssistantMessage(text string) AnthropicMessage

+ func CreateAnthropicUserMessage(text string) AnthropicMessage

+ func CreateAnthropicUserMessageWithBlocks(blocks []AnthropicContentBlock) AnthropicMessage

+ type AnthropicMessagesRequest struct

+ HeaderMetadata map[string]any

+ MaxTokens int

+ Messages []AnthropicMessage

+ Metadata *AnthropicRequestMetadata

+ Model string

+ Models []string

+ Plugins []Plugin

+ Provider *Provider

+ ServiceTier string

+ SessionID string

+ StopSequences []string

+ Stream bool

+ System any

+ Temperature *float64

+ Thinking *AnthropicThinkingConfig

+ ToolChoice *AnthropicToolChoice

+ Tools []AnthropicTool

+ TopK *int

+ TopP *float64

+ User string

+ func (r *AnthropicMessagesRequest) GetMetadata() map[string]any

+ type AnthropicMessagesResponse struct

+ Content []AnthropicResponseContentBlock

+ ID string

+ Model string

+ Role string

+ StopReason *string

+ StopSequence *string

+ Type string

+ Usage AnthropicUsage

+ func (r *AnthropicMessagesResponse) GetStopReason() string

+ func (r *AnthropicMessagesResponse) GetTextBlocks() []AnthropicResponseContentBlock

+ func (r *AnthropicMessagesResponse) GetTextContent() string

+ func (r *AnthropicMessagesResponse) GetThinkingContent() string

+ func (r *AnthropicMessagesResponse) GetToolUseBlocks() []AnthropicResponseContentBlock

+ func (r *AnthropicMessagesResponse) IsToolUse() bool

+ type AnthropicOption = RequestOption[*AnthropicMessagesRequest]

+ func WithAnthropicHeaderMetadata(metadata map[string]any) AnthropicOption

+ func WithAnthropicMaxTokens(maxTokens int) AnthropicOption

+ func WithAnthropicMessages(messages []AnthropicMessage) AnthropicOption

+ func WithAnthropicModel(model string) AnthropicOption

+ func WithAnthropicModels(models ...string) AnthropicOption

+ func WithAnthropicPlugins(plugins ...Plugin) AnthropicOption

+ func WithAnthropicProvider(provider Provider) AnthropicOption

+ func WithAnthropicRequestMetadata(metadata AnthropicRequestMetadata) AnthropicOption

+ func WithAnthropicServiceTier(tier string) AnthropicOption

+ func WithAnthropicSessionID(sessionID string) AnthropicOption

+ func WithAnthropicStopSequences(sequences ...string) AnthropicOption

+ func WithAnthropicSystemBlocks(blocks []AnthropicTextBlock) AnthropicOption

+ func WithAnthropicSystemString(system string) AnthropicOption

+ func WithAnthropicTemperature(temperature float64) AnthropicOption

+ func WithAnthropicThinkingDisabled() AnthropicOption

+ func WithAnthropicThinkingEnabled(budgetTokens int) AnthropicOption

+ func WithAnthropicToolChoiceAny() AnthropicOption

+ func WithAnthropicToolChoiceAuto() AnthropicOption

+ func WithAnthropicToolChoiceNone() AnthropicOption

+ func WithAnthropicToolChoiceSpecific(name string) AnthropicOption

+ func WithAnthropicTools(tools ...AnthropicTool) AnthropicOption

+ func WithAnthropicTopK(topK int) AnthropicOption

+ func WithAnthropicTopP(topP float64) AnthropicOption

+ func WithAnthropicUser(user string) AnthropicOption

+ type AnthropicRequestMetadata struct

+ UserID string

+ type AnthropicResponseContentBlock struct

+ Citations []AnthropicCitation

+ Content json.RawMessage

+ Data string

+ ID string

+ Input json.RawMessage

+ Name string

+ Signature string

+ Text string

+ Thinking string

+ Type string

+ type AnthropicStream = Stream[AnthropicStreamEvent]

+ type AnthropicStreamDelta struct

+ PartialJSON string

+ Signature string

+ StopReason string

+ StopSequence string

+ Text string

+ Thinking string

+ Type string

+ type AnthropicStreamError struct

+ Message string

+ Type string

+ type AnthropicStreamEvent struct

+ ContentBlock *AnthropicResponseContentBlock

+ Delta *AnthropicStreamDelta

+ Error *AnthropicStreamError

+ Index *int

+ Message *AnthropicMessagesResponse

+ Type string

+ Usage *AnthropicStreamUsage

+ func (e *AnthropicStreamEvent) GetTextDelta() string

+ type AnthropicStreamUsage struct

+ InputTokens int

+ OutputTokens int

+ type AnthropicTextBlock struct

+ Text string

+ Type string

+ type AnthropicThinkingConfig struct

+ BudgetTokens int

+ Type string

+ type AnthropicTool struct

+ Description string

+ InputSchema map[string]any

+ MaxUses *int

+ Name string

+ Type string

+ func CreateAnthropicBashTool() AnthropicTool

+ func CreateAnthropicCustomTool(name, description string, schema map[string]any) AnthropicTool

+ func CreateAnthropicTextEditorTool() AnthropicTool

+ func CreateAnthropicWebSearchTool(maxUses *int) AnthropicTool

+ type AnthropicToolChoice struct

+ DisableParallelToolUse *bool

+ Name string

+ Type string

+ type AnthropicUsage struct

+ CacheCreationInputTokens int

+ CacheReadInputTokens int

+ InputTokens int

+ OutputTokens int

+ ServiceTier string

+ type AssignKeysRequest struct

+ KeyHashes []string

+ type AssignKeysResponse struct

+ AssignedCount int

+ type AssignMembersRequest struct

+ MemberUserIDs []string

+ type AssignMembersResponse struct

+ AssignedCount int

+ type AuthURLParams struct

+ CallbackURL string

+ CodeChallenge string

+ CodeChallengeMethod CodeChallengeMethod

+ type BroadcastTrace struct

+ CompletionTokens int

+ Cost float64

+ Duration time.Duration

+ EndTime time.Time

+ Metadata map[string]string

+ Model string

+ ParentSpanID string

+ PromptTokens int

+ RawAttributes map[string]string

+ ResourceAttributes map[string]string

+ SessionID string

+ SpanID string

+ SpanName string

+ StartTime time.Time

+ TotalTokens int

+ TraceID string

+ UserID string

+ func ExtractBroadcastTraces(payload *OTLPExportTraceRequest) []BroadcastTrace

+ func ParseBroadcastTraces(data []byte) ([]BroadcastTrace, error)

type ChatCompletionOption

+ func WithMinP(minP float64) ChatCompletionOption

+ func WithRequestRetry(maxRetries int, retryDelay time.Duration) ChatCompletionOption

+ func WithRequestTimeout(timeout time.Duration) ChatCompletionOption

+ func WithStreamChannelBuffer(n int) ChatCompletionOption

+ func WithStreamMaxBackoff(d time.Duration) ChatCompletionOption

+ func WithStreamMaxRetries(n int) ChatCompletionOption

+ func WithTopA(topA float64) ChatCompletionOption

+ type CircuitBreaker struct

+ func NewCircuitBreaker(config *CircuitBreakerConfig) *CircuitBreaker

+ func (cb *CircuitBreaker) AllowRequest() bool

+ func (cb *CircuitBreaker) RecordFailure()

+ func (cb *CircuitBreaker) RecordSuccess()

+ func (cb *CircuitBreaker) Reset()

+ func (cb *CircuitBreaker) State() CircuitState

+ type CircuitBreakerConfig struct

+ FailureThreshold int

+ HalfOpenMaxAttempts int

+ ResetTimeout time.Duration

+ func DefaultCircuitBreakerConfig() *CircuitBreakerConfig

+ type CircuitBreakerError struct

+ Message string

+ State CircuitState

+ func IsCircuitBreakerError(err error) (*CircuitBreakerError, bool)

+ func (e *CircuitBreakerError) Error() string

+ type CircuitState int

+ const CircuitClosed

+ const CircuitHalfOpen

+ const CircuitOpen

+ func (s CircuitState) String() string

type Client

+ func (c *Client) AssignKeysToGuardrail(ctx context.Context, id string, request *AssignKeysRequest) (*AssignKeysResponse, error)

+ func (c *Client) AssignMembersToGuardrail(ctx context.Context, id string, request *AssignMembersRequest) (*AssignMembersResponse, error)

+ func (c *Client) CreateAnthropicMessage(ctx context.Context, messages []AnthropicMessage, opts ...AnthropicOption) (*AnthropicMessagesResponse, error)

+ func (c *Client) CreateAnthropicMessageStream(ctx context.Context, messages []AnthropicMessage, opts ...AnthropicOption) (*AnthropicStream, error)

+ func (c *Client) CreateAuthCode(ctx context.Context, request *CreateAuthCodeRequest) (*CreateAuthCodeResponse, error)

+ func (c *Client) CreateGuardrail(ctx context.Context, request *CreateGuardrailRequest) (*Guardrail, error)

+ func (c *Client) DeleteGuardrail(ctx context.Context, id string) (*DeleteGuardrailResponse, error)

+ func (c *Client) ExchangeAuthCode(ctx context.Context, request *ExchangeAuthCodeRequest) (*ExchangeAuthCodeResponse, error)

+ func (c *Client) GetGuardrail(ctx context.Context, id string) (*Guardrail, error)

+ func (c *Client) ListAllKeyAssignments(ctx context.Context, options *ListGuardrailsOptions) (*ListGuardrailKeyAssignmentsResponse, error)

+ func (c *Client) ListAllMemberAssignments(ctx context.Context, options *ListGuardrailsOptions) (*ListGuardrailMemberAssignmentsResponse, error)

+ func (c *Client) ListGuardrailKeyAssignments(ctx context.Context, id string, options *ListGuardrailsOptions) (*ListGuardrailKeyAssignmentsResponse, error)

+ func (c *Client) ListGuardrailMemberAssignments(ctx context.Context, id string, options *ListGuardrailsOptions) (*ListGuardrailMemberAssignmentsResponse, error)

+ func (c *Client) ListGuardrails(ctx context.Context, options *ListGuardrailsOptions) (*ListGuardrailsResponse, error)

+ func (c *Client) ListModelsUser(ctx context.Context) (*ModelsResponse, error)

+ func (c *Client) ListZDREndpoints(ctx context.Context) (*ZDREndpointsResponse, error)

+ func (c *Client) UnassignKeysFromGuardrail(ctx context.Context, id string, request *AssignKeysRequest) error

+ func (c *Client) UnassignMembersFromGuardrail(ctx context.Context, id string, request *AssignMembersRequest) error

+ func (c *Client) UpdateGuardrail(ctx context.Context, id string, request *UpdateGuardrailRequest) (*Guardrail, error)

type ClientOption

+ func WithCircuitBreaker(config *CircuitBreakerConfig) ClientOption

+ func WithStreamConfig(config *StreamConfig) ClientOption

+ type CodeChallengeMethod string

+ const CodeChallengeMethodPlain

+ const CodeChallengeMethodS256

type CompletionOption

+ func WithCompletionFrequencyPenalty(penalty float64) CompletionOption

+ func WithCompletionMinP(minP float64) CompletionOption

+ func WithCompletionPresencePenalty(penalty float64) CompletionOption

+ func WithCompletionRepetitionPenalty(penalty float64) CompletionOption

+ func WithCompletionRequestRetry(maxRetries int, retryDelay time.Duration) CompletionOption

+ func WithCompletionRequestTimeout(timeout time.Duration) CompletionOption

+ func WithCompletionSeed(seed int) CompletionOption

+ func WithCompletionStreamChannelBuffer(n int) CompletionOption

+ func WithCompletionStreamMaxBackoff(d time.Duration) CompletionOption

+ func WithCompletionStreamMaxRetries(n int) CompletionOption

+ func WithCompletionTopA(topA float64) CompletionOption

+ func WithCompletionTopK(topK int) CompletionOption

+ type CostResult struct

+ CompletionCost float64

+ PromptCost float64

+ TotalCost float64

+ func EstimateCost(pricing ModelPricing, usage Usage) CostResult

+ func EstimateCostFromTokens(promptPrice, completionPrice string, promptTokens, completionTokens int) CostResult

+ func EstimateCostWithCaching(pricing ModelPricing, usage Usage, cacheReadTokens, cacheWriteTokens int) CostResult

+ type CreateAuthCodeData struct

+ AppID float64

+ CreatedAt string

+ ID string

+ type CreateAuthCodeRequest struct

+ CallbackURL string

+ CodeChallenge *string

+ CodeChallengeMethod CodeChallengeMethod

+ ExpiresAt *string

+ KeyLabel *string

+ Limit *float64

+ UsageLimitType UsageLimitType

+ type CreateAuthCodeResponse struct

+ Data CreateAuthCodeData

+ type CreateGuardrailRequest struct

+ AllowedModels []string

+ AllowedProviders []string

+ Description *string

+ EnforceZDR *bool

+ LimitUSD *float64

+ Name string

+ ResetInterval *ResetInterval

+ type DeleteGuardrailResponse struct

+ Deleted bool

+ type EndpointFilter struct

+ MaxCompletionPrice float64

+ MaxPromptPrice float64

+ MinStatus float64

+ ProviderName string

+ Quantization string

+ RequiredParameters []string

+ type ExchangeAuthCodeRequest struct

+ Code string

+ CodeChallengeMethod CodeChallengeMethod

+ CodeVerifier *string

+ type ExchangeAuthCodeResponse struct

+ Key string

+ UserID *string

+ type Guardrail struct

+ AllowedModels []string

+ AllowedProviders []string

+ CreatedAt string

+ Description *string

+ EnforceZDR *bool

+ ID string

+ LimitUSD *float64

+ Name string

+ ResetInterval *ResetInterval

+ UpdatedAt *string

+ type GuardrailKeyAssignment struct

+ AssignedBy *string

+ CreatedAt string

+ GuardrailID string

+ ID string

+ KeyHash string

+ OrganizationID string

+ type GuardrailMemberAssignment struct

+ AssignedBy *string

+ CreatedAt string

+ GuardrailID string

+ ID string

+ OrganizationID string

+ UserID string

+ type ListGuardrailKeyAssignmentsResponse struct

+ Data []GuardrailKeyAssignment

+ TotalCount int

+ type ListGuardrailMemberAssignmentsResponse struct

+ Data []GuardrailMemberAssignment

+ TotalCount int

+ type ListGuardrailsOptions struct

+ Limit *int

+ Offset *int

+ type ListGuardrailsResponse struct

+ Data []Guardrail

+ TotalCount int

type Model

+ ExpirationDate *string

+ func FilterModels(models []Model, predicate func(*Model) bool) []Model

+ func (m *Model) HasInputModality(modality string) bool

+ func (m *Model) HasOutputModality(modality string) bool

+ func (m *Model) SupportsAudio() bool

+ func (m *Model) SupportsJSON() bool

+ func (m *Model) SupportsParameter(param string) bool

+ func (m *Model) SupportsStreaming() bool

+ func (m *Model) SupportsTools() bool

+ func (m *Model) SupportsVision() bool

type ModelArchitecture

+ Modality *string

type ModelEndpoint

+ func CheapestModelEndpoint(endpoints []ModelEndpoint) *ModelEndpoint

+ func FilterModelEndpoints(endpoints []ModelEndpoint, filter EndpointFilter) []ModelEndpoint

type ModelPerRequestLimits

+ CompletionTokens *float64

+ PromptTokens *float64

+ type OTLPAnyValue struct

+ ArrayValue *OTLPArrayValue

+ BoolValue *bool

+ DoubleValue *float64

+ IntValue *string

+ StringValue *string

+ func (v OTLPAnyValue) StringVal() string

+ type OTLPArrayValue struct

+ Values []OTLPAnyValue

+ type OTLPAttribute struct

+ Key string

+ Value OTLPAnyValue

+ type OTLPEvent struct

+ Attributes []OTLPAttribute

+ Name string

+ TimeUnixNano string

+ type OTLPExportTraceRequest struct

+ ResourceSpans []OTLPResourceSpan

+ func ParseBroadcastPayload(data []byte) (*OTLPExportTraceRequest, error)

+ type OTLPResource struct

+ Attributes []OTLPAttribute

+ type OTLPResourceSpan struct

+ Resource OTLPResource

+ ScopeSpans []OTLPScopeSpan

+ type OTLPScope struct

+ Name string

+ Version string

+ type OTLPScopeSpan struct

+ Scope *OTLPScope

+ Spans []OTLPSpan

+ type OTLPSpan struct

+ Attributes []OTLPAttribute

+ EndTimeUnixNano string

+ Events []OTLPEvent

+ Kind int

+ Name string

+ ParentSpanID string

+ SpanID string

+ StartTimeUnixNano string

+ Status *OTLPStatus

+ TraceID string

+ type OTLPStatus struct

+ Code int

+ Message string

+ type PercentileStats struct

+ P50 float64

+ P75 float64

+ P90 float64

+ P99 float64

+ type PublicEndpoint struct

+ ContextLength float64

+ LatencyLast30m *PercentileStats

+ MaxCompletionTokens *float64

+ MaxPromptTokens *float64

+ ModelID string

+ ModelName string

+ Name string

+ Pricing PublicEndpointPricing

+ ProviderName string

+ Quantization *string

+ Status float64

+ SupportedParameters []string

+ SupportsImplicitCaching *bool

+ Tag *string

+ ThroughputLast30m *PercentileStats

+ UptimeLast30m *float64

+ func CheapestZDREndpoint(endpoints []PublicEndpoint) *PublicEndpoint

+ func FilterZDREndpoints(endpoints []PublicEndpoint, filter EndpointFilter) []PublicEndpoint

+ type PublicEndpointPricing struct

+ Audio string

+ AudioOutput string

+ Completion string

+ Discount string

+ Image string

+ ImageOutput string

+ ImageToken string

+ InputAudioCache string

+ InputCacheRead string

+ InputCacheWrite string

+ InternalReasoning string

+ Prompt string

+ Request string

+ WebSearch string

+ type ResetInterval string

+ const ResetIntervalDaily

+ const ResetIntervalMonthly

+ const ResetIntervalWeekly

+ type StreamConfig struct

+ ChannelBuffer int

+ InitialBackoff time.Duration

+ MaxBackoff time.Duration

+ MaxRetries int

+ func DefaultStreamConfig() *StreamConfig

+ type UpdateGuardrailRequest struct

+ AllowedModels []string

+ AllowedProviders []string

+ Description *string

+ EnforceZDR *bool

+ LimitUSD *float64

+ Name *string

+ ResetInterval *ResetInterval

+ type UsageLimitType string

+ const UsageLimitDaily

+ const UsageLimitMonthly

+ const UsageLimitWeekly

+ type ZDREndpointsResponse struct

+ Data []PublicEndpoint

v1.4.2

Jan 21, 2026

Changes in this version

+ func AverageEmbeddings(embeddings [][]float64) []float64

+ func ChunkTexts(texts []string, config ChunkConfig) ([][]TextChunk, error)

+ func CosineSimilarity(a, b []float64) float64

+ func EstimateTokens(text string) int

+ func EstimateTokensFromWords(text string) int

+ func WeightedAverageEmbeddings(embeddings [][]float64, weights []float64) []float64

+ type ChunkConfig struct

+ ChunkSize int

+ Overlap int

+ PreserveWords bool

+ SectionHeaders []string

+ Strategy ChunkStrategy

+ TrimWhitespace bool

+ func DefaultChunkConfig() ChunkConfig

+ type ChunkEmbedding struct

+ Chunk TextChunk

+ Embedding []float64

+ type ChunkStrategy string

+ const ChunkByCharacters

+ const ChunkByParagraphs

+ const ChunkBySections

+ const ChunkBySentences

+ const ChunkByTokens

+ type ChunkedEmbeddingResult struct

+ Chunks []ChunkEmbedding

+ Model string

+ TotalTokensUsed int

type Client

+ func (c *Client) CreateChunkedEmbedding(ctx context.Context, text string, model string, config ChunkConfig, ...) (*ChunkedEmbeddingResult, error)

+ func (c *Client) CreateChunkedEmbeddings(ctx context.Context, texts []string, model string, config ChunkConfig, ...) ([]*ChunkedEmbeddingResult, error)

+ type TextChunk struct

+ EndPos int

+ Index int

+ StartPos int

+ Text string

+ func ChunkText(text string, config ChunkConfig) ([]TextChunk, error)

v1.4.1

Jan 15, 2026

Changes in this version

+ func ReadTextFile(filePath string) (string, error)

+ func ReadTextFileWithFilename(filePath string) (content string, filename string, err error)

+ func ValidateTextContent(content string) error

type ContentBuilder

+ func (cb *ContentBuilder) AddTextContent(content string, label string) *ContentBuilder

+ func (cb *ContentBuilder) AddTextFile(filePath string) (*ContentBuilder, error)

+ func (cb *ContentBuilder) AddTextFileWithLabel(filePath string, label string) (*ContentBuilder, error)

type Message

+ func CreateUserMessageWithTextContent(text string, content string, filename string) Message

+ func CreateUserMessageWithTextFile(text string, filePath string) (Message, error)

+ func CreateUserMessageWithTextFiles(text string, filePaths ...string) (Message, error)

+ type ResponsesTool struct

+ Description string

+ Name string

+ Parameters map[string]any

+ Strict *bool

+ Type string

+ func ConvertToolToResponsesTool(tool Tool) ResponsesTool

+ func ConvertToolsToResponsesTools(tools []Tool) []ResponsesTool

+ func CreateResponsesTool(name, description string, parameters map[string]any) ResponsesTool

v1.4.0

Jan 9, 2026

Changes in this version

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMedium

+ const ReasoningEffortMinimal

+ var ErrNoResponsesInput = &ValidationError

type Client

+ func (c *Client) CreateResponse(ctx context.Context, input interface{}, opts ...ResponsesOption) (*ResponsesResponse, error)

+ func (c *Client) CreateResponseStream(ctx context.Context, input interface{}, opts ...ResponsesOption) (*ResponsesStream, error)

+ type RequestOption func(T)

+ type ResponsesAnnotation struct

+ EndIndex int

+ StartIndex int

+ Type string

+ URL string

+ type ResponsesInputContent struct

+ Text string

+ Type string

+ type ResponsesInputItem struct

+ CallID string

+ Content []ResponsesInputContent

+ ID string

+ Output string

+ Role string

+ Status string

+ Type string

+ func CreateResponsesAssistantMessage(text string) ResponsesInputItem

+ func CreateResponsesFunctionOutput(callID, output string) ResponsesInputItem

+ func CreateResponsesMessage(role, text string) ResponsesInputItem

+ func CreateResponsesSystemMessage(text string) ResponsesInputItem

+ func CreateResponsesUserMessage(text string) ResponsesInputItem

+ type ResponsesOption = RequestOption[*ResponsesRequest]

+ func WithResponsesInput(input any) ResponsesOption

+ func WithResponsesMaxOutputTokens(tokens int) ResponsesOption

+ func WithResponsesMetadata(metadata map[string]interface{}) ResponsesOption

+ func WithResponsesModel(model string) ResponsesOption

+ func WithResponsesPlugins(plugins ...Plugin) ResponsesOption

+ func WithResponsesReasoning(ptr *ResponsesReasoning) ResponsesOption

+ func WithResponsesReasoningEffort(effort string) ResponsesOption

+ func WithResponsesTemperature(temperature float64) ResponsesOption

+ func WithResponsesToolChoice(toolChoice any) ResponsesOption

+ func WithResponsesTools(tools ...Tool) ResponsesOption

+ func WithResponsesTopP(topP float64) ResponsesOption

+ func WithResponsesWebSearch(maxResults int) ResponsesOption

+ type ResponsesOutput struct

+ Arguments string

+ CallID string

+ Content []ResponsesOutputContent

+ ID string

+ Name string

+ Role string

+ Status string

+ Type string

+ type ResponsesOutputContent struct

+ Annotations []ResponsesAnnotation

+ EncryptedContent string

+ Summary []string

+ Text string

+ Type string

+ type ResponsesReasoning struct

+ Effort string

+ type ResponsesRequest struct

+ Input any

+ MaxOutputTokens *int

+ Metadata map[string]interface{}

+ Model string

+ Plugins []Plugin

+ Reasoning *ResponsesReasoning

+ Stream bool

+ Temperature *float64

+ ToolChoice any

+ Tools []Tool

+ TopP *float64

+ func (r *ResponsesRequest) GetMetadata() map[string]interface{}

+ type ResponsesResponse struct

+ CreatedAt int64

+ ID string

+ Metadata map[string]interface{}

+ Model string

+ Object string

+ Output []ResponsesOutput

+ Status string

+ Usage ResponsesUsage

+ func (r *ResponsesResponse) GetAnnotations() []ResponsesAnnotation

+ func (r *ResponsesResponse) GetFunctionCalls() []ResponsesOutput

+ func (r *ResponsesResponse) GetReasoningSummary() []string

+ func (r *ResponsesResponse) GetTextContent() string

+ type ResponsesStream = Stream[ResponsesResponse]

+ type ResponsesUsage struct

+ InputTokens int

+ OutputTokens int

+ ReasoningTokens int

+ TotalTokens int

v1.3.1

Jan 8, 2026

Changes in this version

type ChatCompletionOption

+ func WithUser(user string) ChatCompletionOption

type ChatCompletionRequest

+ User string

type CompletionOption

+ func WithCompletionUser(user string) CompletionOption

type CompletionRequest

+ User string

v1.3.0

Dec 30, 2025

Changes in this version

+ func ConvertToolResultToMCP(result MCPToolResult) string

+ type MCPContent struct

+ Data string

+ MimeType string

+ Text string

+ Type string

+ type MCPInputSchema struct

+ AdditionalProperties *bool

+ Properties map[string]interface{}

+ Required []string

+ Type string

+ type MCPTool struct

+ Description string

+ InputSchema *MCPInputSchema

+ Name string

+ func ParseMCPToolFromJSON(data []byte) (MCPTool, error)

+ func ParseMCPToolsFromJSON(data []byte) ([]MCPTool, error)

+ type MCPToolResult struct

+ Content []MCPContent

+ IsError bool

type Tool

+ func ConvertMCPTool(mcpTool MCPTool) Tool

+ func ConvertMCPTools(mcpTools []MCPTool) []Tool

v1.2.1

Dec 5, 2025

Changes in this version

type ListModelsOptions

+ SupportedParameters string

+ UseRSS string

+ UseRSSChatLinks string

v1.2.0

Dec 1, 2025

Changes in this version

type Client

+ func (c *Client) CreateEmbedding(ctx context.Context, input interface{}, model string, opts ...EmbeddingOption) (*EmbeddingResponse, error)

+ func (c *Client) CreateEmbeddings(ctx context.Context, inputs []string, model string, opts ...EmbeddingOption) (*EmbeddingResponse, error)

+ func (c *Client) ListEmbeddingsModels(ctx context.Context) (*EmbeddingsModelsResponse, error)

+ type EmbeddingContentPart struct

+ ImageURL *EmbeddingImageURL

+ Text string

+ Type string

+ type EmbeddingData struct

+ Embedding interface{}

+ Index int

+ Object string

+ func (e *EmbeddingData) GetEmbeddingBase64() string

+ func (e *EmbeddingData) GetEmbeddingVector() []float64

+ type EmbeddingImageURL struct

+ URL string

+ type EmbeddingMultimodalInput struct

+ Content []EmbeddingContentPart

+ type EmbeddingOption func(*EmbeddingRequest)

+ func WithEmbeddingAllowFallbacks(allow bool) EmbeddingOption

+ func WithEmbeddingDataCollection(policy string) EmbeddingOption

+ func WithEmbeddingDimensions(dimensions int) EmbeddingOption

+ func WithEmbeddingEncodingFormat(format string) EmbeddingOption

+ func WithEmbeddingIgnoreProviders(providers ...string) EmbeddingOption

+ func WithEmbeddingInputType(inputType string) EmbeddingOption

+ func WithEmbeddingOnlyProviders(providers ...string) EmbeddingOption

+ func WithEmbeddingProvider(provider Provider) EmbeddingOption

+ func WithEmbeddingProviderOrder(providers ...string) EmbeddingOption

+ func WithEmbeddingProviderSort(sort string) EmbeddingOption

+ func WithEmbeddingUser(user string) EmbeddingOption

+ type EmbeddingRequest struct

+ Dimensions *int

+ EncodingFormat string

+ Input interface{}

+ InputType string

+ Model string

+ Provider *Provider

+ User string

+ type EmbeddingResponse struct

+ Data []EmbeddingData

+ ID string

+ Model string

+ Object string

+ Usage *EmbeddingUsage

+ type EmbeddingUsage struct

+ Cost *float64

+ PromptTokens int

+ TotalTokens int

+ type EmbeddingsModelsResponse struct

+ Data []Model

v1.1.1

Nov 7, 2025

v1.1.0

Nov 7, 2025

Changes in this version

+ func EncodeAudioBytesToBase64(audioData []byte, format string) (string, error)

+ func EncodeAudioToBase64(audioPath string) (string, string, error)

+ func EncodeImageBytesToBase64(imageData []byte, contentType string) string

+ func EncodeImageToBase64(imagePath string) (string, error)

+ func EncodePDFBytesToBase64(pdfData []byte) string

+ func EncodePDFToBase64(pdfPath string) (string, error)

type Annotation

+ FileAnnotation *FileAnnotation

+ type ContentBuilder struct

+ func NewContentBuilder() *ContentBuilder

+ func (cb *ContentBuilder) AddAudio(audioData string, format string) *ContentBuilder

+ func (cb *ContentBuilder) AddBase64Audio(audioPath string) (*ContentBuilder, error)

+ func (cb *ContentBuilder) AddBase64PDF(pdfPath string, filename string) (*ContentBuilder, error)

+ func (cb *ContentBuilder) AddFile(filename string, fileData string) *ContentBuilder

+ func (cb *ContentBuilder) AddImage(imageURL string) *ContentBuilder

+ func (cb *ContentBuilder) AddImageWithDetail(imageURL string, detail string) *ContentBuilder

+ func (cb *ContentBuilder) AddPDF(pdfURL string, filename string) *ContentBuilder

+ func (cb *ContentBuilder) AddText(text string) *ContentBuilder

+ func (cb *ContentBuilder) Build() []ContentPart

+ func (cb *ContentBuilder) BuildMessage(role string) Message

type ContentPart

+ File *File

+ InputAudio *InputAudio

+ type File struct

+ FileData string

+ Filename string

+ type FileAnnotation struct

+ ContentType string

+ Filename string

+ Metadata map[string]interface{}

+ ParsedContent string

+ type InputAudio struct

+ Data string

+ Format string

type Message

+ func CreateUserMessageWithAudio(text string, audioData string, format string) Message

+ func CreateUserMessageWithBase64Audio(text string, audioPath string) (Message, error)

+ func CreateUserMessageWithBase64Image(text string, imagePath string) (Message, error)

+ func CreateUserMessageWithBase64Images(text string, imagePaths ...string) (Message, error)

+ func CreateUserMessageWithBase64PDF(text string, pdfPath string, filename string) (Message, error)

+ func CreateUserMessageWithFiles(text string, files []File) Message

+ func CreateUserMessageWithImage(text string, imageURL string) Message

+ func CreateUserMessageWithImageDetail(text string, imageURL string, detail string) Message

+ func CreateUserMessageWithImages(text string, imageURLs ...string) Message

+ func CreateUserMessageWithPDF(text string, pdfURL string, filename string) Message

+ type PDFParserConfig struct

+ Engine string

type Plugin

+ PDF *PDFParserConfig

+ func CreateFileParserPlugin(engine string) Plugin

v1.0.0

Oct 9, 2025

Changes in this version

+ var ErrNoAPIKey = &ValidationError

+ var ErrNoMessages = &ValidationError

+ var ErrNoModel = &ValidationError

+ var ErrNoPrompt = &ValidationError

+ func ConcatenateChatStreamResponses(responses []ChatCompletionResponse) string

+ func ConcatenateCompletionStreamResponses(responses []CompletionResponse) string

+ func DefaultWebSearchPrompt(date string) string

+ func RetryWithBackoff(ctx context.Context, config *RetryConfig, fn func() error) error

+ func WithOnlineModel(model string) string

+ type APIError struct

+ Code string

+ Message string

+ Metadata map[string]interface{}

+ Type string

+ type APIKey struct

+ CreatedAt string

+ Disabled bool

+ Hash string

+ Label string

+ Limit float64

+ Name string

+ UpdatedAt string

+ type ActivityData struct

+ BYOKUsageInference float64

+ CompletionTokens float64

+ Date string

+ EndpointID string

+ Model string

+ ModelPermaslug string

+ PromptTokens float64

+ ProviderName string

+ ReasoningTokens float64

+ Requests float64

+ Usage float64

+ type ActivityOptions struct

+ Date string

+ type ActivityResponse struct

+ Data []ActivityData

+ type Annotation struct

+ Type string

+ URLCitation *URLCitation

+ type ChatCompletionOption func(*ChatCompletionRequest)

+ func WithAllowFallbacks(allow bool) ChatCompletionOption

+ func WithDataCollection(policy string) ChatCompletionOption

+ func WithFloorPrice() ChatCompletionOption

+ func WithFrequencyPenalty(penalty float64) ChatCompletionOption

+ func WithIgnoreProviders(providers ...string) ChatCompletionOption

+ func WithJSONMode() ChatCompletionOption

+ func WithJSONSchema(name string, strict bool, schema map[string]interface{}) ChatCompletionOption

+ func WithLogProbs(topLogProbs int) ChatCompletionOption

+ func WithMaxPrice(maxPrice MaxPrice) ChatCompletionOption

+ func WithMaxTokens(maxTokens int) ChatCompletionOption

+ func WithMessages(messages []Message) ChatCompletionOption

+ func WithMetadata(metadata map[string]interface{}) ChatCompletionOption

+ func WithModel(model string) ChatCompletionOption

+ func WithModels(models ...string) ChatCompletionOption

+ func WithNitro() ChatCompletionOption

+ func WithOnlyProviders(providers ...string) ChatCompletionOption

+ func WithParallelToolCalls(parallel *bool) ChatCompletionOption

+ func WithPlugins(plugins ...Plugin) ChatCompletionOption

+ func WithPresencePenalty(penalty float64) ChatCompletionOption

+ func WithProvider(provider Provider) ChatCompletionOption

+ func WithProviderOrder(providers ...string) ChatCompletionOption

+ func WithProviderSort(sort string) ChatCompletionOption

+ func WithQuantizations(quantizations ...string) ChatCompletionOption

+ func WithRepetitionPenalty(penalty float64) ChatCompletionOption

+ func WithRequireParameters(require bool) ChatCompletionOption

+ func WithResponseFormat(format ResponseFormat) ChatCompletionOption

+ func WithRoute(route string) ChatCompletionOption

+ func WithSeed(seed int) ChatCompletionOption

+ func WithStop(stop ...string) ChatCompletionOption

+ func WithTemperature(temperature float64) ChatCompletionOption

+ func WithToolChoice(toolChoice interface{}) ChatCompletionOption

+ func WithTools(tools ...Tool) ChatCompletionOption

+ func WithTopK(topK int) ChatCompletionOption

+ func WithTopP(topP float64) ChatCompletionOption

+ func WithTransforms(transforms ...string) ChatCompletionOption

+ func WithWebSearchOptions(options *WebSearchOptions) ChatCompletionOption

+ func WithZDR(enabled bool) ChatCompletionOption

+ type ChatCompletionRequest struct

+ FrequencyPenalty *float64

+ LogProbs *bool

+ MaxTokens *int

+ Messages []Message

+ Metadata map[string]interface{}

+ MinP *float64

+ Model string

+ Models []string

+ ParallelToolCalls *bool

+ Plugins []Plugin

+ PresencePenalty *float64

+ Provider *Provider

+ RepetitionPenalty *float64

+ ResponseFormat *ResponseFormat

+ Route string

+ Seed *int

+ Stop []string

+ Stream bool

+ Temperature *float64

+ ToolChoice interface{}

+ Tools []Tool

+ TopA *float64

+ TopK *int

+ TopLogProbs *int

+ TopP *float64

+ Transforms []string

+ WebSearchOptions *WebSearchOptions

+ func (r *ChatCompletionRequest) GetMetadata() map[string]interface{}

+ type ChatCompletionResponse struct

+ Choices []Choice

+ Created int64

+ ID string

+ Model string

+ Object string

+ SystemFingerprint string

+ Usage Usage

+ type ChatStream = Stream[ChatCompletionResponse]

+ type Choice struct

+ Delta *Message

+ FinishReason string

+ Index int

+ LogProbs *LogProbs

+ Message Message

+ type Client struct

+ func NewClient(opts ...ClientOption) *Client

+ func (c *Client) ChatComplete(ctx context.Context, messages []Message, opts ...ChatCompletionOption) (*ChatCompletionResponse, error)

+ func (c *Client) ChatCompleteStream(ctx context.Context, messages []Message, opts ...ChatCompletionOption) (*ChatStream, error)

+ func (c *Client) Complete(ctx context.Context, prompt string, opts ...CompletionOption) (*CompletionResponse, error)

+ func (c *Client) CompleteStream(ctx context.Context, prompt string, opts ...CompletionOption) (*CompletionStream, error)

+ func (c *Client) CompleteWithContext(ctx context.Context, contextPrompt, userPrompt string, ...) (*CompletionResponse, error)

+ func (c *Client) CompleteWithExamples(ctx context.Context, instruction string, examples []string, prompt string, ...) (*CompletionResponse, error)

+ func (c *Client) CreateKey(ctx context.Context, request *CreateKeyRequest) (*CreateKeyResponse, error)

+ func (c *Client) DeleteKey(ctx context.Context, hash string) (*DeleteKeyResponse, error)

+ func (c *Client) GetActivity(ctx context.Context, opts *ActivityOptions) (*ActivityResponse, error)

+ func (c *Client) GetCredits(ctx context.Context) (*CreditsResponse, error)

+ func (c *Client) GetKey(ctx context.Context) (*KeyResponse, error)

+ func (c *Client) GetKeyByHash(ctx context.Context, hash string) (*GetKeyByHashResponse, error)

+ func (c *Client) ListKeys(ctx context.Context, options *ListKeysOptions) (*ListKeysResponse, error)

+ func (c *Client) ListModelEndpoints(ctx context.Context, author, slug string) (*ModelEndpointsResponse, error)

+ func (c *Client) ListModels(ctx context.Context, opts *ListModelsOptions) (*ModelsResponse, error)

+ func (c *Client) ListProviders(ctx context.Context) (*ProvidersResponse, error)

+ func (c *Client) UpdateKey(ctx context.Context, hash string, request *UpdateKeyRequest) (*UpdateKeyResponse, error)

+ type ClientOption func(*Client)

+ func WithAPIKey(apiKey string) ClientOption

+ func WithAppName(appName string) ClientOption

+ func WithBaseURL(baseURL string) ClientOption

+ func WithDefaultModel(model string) ClientOption

+ func WithHTTPClient(httpClient *http.Client) ClientOption

+ func WithHeader(key, value string) ClientOption

+ func WithReferer(referer string) ClientOption

+ func WithRetry(maxRetries int, retryDelay time.Duration) ClientOption

+ func WithTimeout(timeout time.Duration) ClientOption

+ type CompletionChoice struct

+ FinishReason string

+ Index int

+ LogProbs *LogProbs

+ Text string

+ type CompletionOption func(*CompletionRequest)

+ func WithCompletionAllowFallbacks(allow bool) CompletionOption

+ func WithCompletionBestOf(bestOf int) CompletionOption

+ func WithCompletionDataCollection(policy string) CompletionOption

+ func WithCompletionEcho(echo bool) CompletionOption

+ func WithCompletionFloorPrice() CompletionOption

+ func WithCompletionIgnoreProviders(providers ...string) CompletionOption

+ func WithCompletionJSONMode() CompletionOption

+ func WithCompletionJSONSchema(name string, strict bool, schema map[string]interface{}) CompletionOption

+ func WithCompletionLogProbs(logProbs int) CompletionOption

+ func WithCompletionMaxPrice(maxPrice MaxPrice) CompletionOption

+ func WithCompletionMaxTokens(maxTokens int) CompletionOption

+ func WithCompletionMetadata(metadata map[string]interface{}) CompletionOption

+ func WithCompletionModel(model string) CompletionOption

+ func WithCompletionModels(models ...string) CompletionOption

+ func WithCompletionN(n int) CompletionOption

+ func WithCompletionNitro() CompletionOption

+ func WithCompletionOnlyProviders(providers ...string) CompletionOption

+ func WithCompletionPlugins(plugins ...Plugin) CompletionOption

+ func WithCompletionProvider(provider Provider) CompletionOption

+ func WithCompletionProviderOrder(providers ...string) CompletionOption

+ func WithCompletionProviderSort(sort string) CompletionOption

+ func WithCompletionQuantizations(quantizations ...string) CompletionOption

+ func WithCompletionRequireParameters(require bool) CompletionOption

+ func WithCompletionResponseFormat(format ResponseFormat) CompletionOption

+ func WithCompletionRoute(route string) CompletionOption

+ func WithCompletionStop(stop ...string) CompletionOption

+ func WithCompletionSuffix(suffix string) CompletionOption

+ func WithCompletionTemperature(temperature float64) CompletionOption

+ func WithCompletionTopP(topP float64) CompletionOption

+ func WithCompletionTransforms(transforms ...string) CompletionOption

+ func WithCompletionWebSearchOptions(options *WebSearchOptions) CompletionOption

+ func WithCompletionZDR(enabled bool) CompletionOption

+ type CompletionRequest struct

+ BestOf *int

+ Echo *bool

+ FrequencyPenalty *float64

+ LogProbs *int

+ MaxTokens *int

+ Metadata map[string]interface{}

+ MinP *float64

+ Model string

+ Models []string

+ N *int

+ Plugins []Plugin

+ PresencePenalty *float64

+ Prompt string

+ Provider *Provider

+ RepetitionPenalty *float64

+ ResponseFormat *ResponseFormat

+ Route string

+ Seed *int

+ Stop []string

+ Stream bool

+ Suffix *string

+ Temperature *float64

+ TopA *float64

+ TopK *int

+ TopP *float64

+ Transforms []string

+ WebSearchOptions *WebSearchOptions

+ func (r *CompletionRequest) GetMetadata() map[string]interface{}

+ type CompletionResponse struct

+ Choices []CompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ Usage Usage

+ type CompletionStream = Stream[CompletionResponse]

+ type ContentPart struct

+ ImageURL *ImageURL

+ Text string

+ Type string

+ type CreateKeyRequest struct

+ IncludeBYOKInLimit *bool

+ Limit *float64

+ Name string

+ type CreateKeyResponse struct

+ Data APIKey

+ Key string

+ type CreditsData struct

+ TotalCredits float64

+ TotalUsage float64

+ type CreditsResponse struct

+ Data CreditsData

+ type DeleteKeyData struct

+ Success bool

+ type DeleteKeyResponse struct

+ Data DeleteKeyData

+ type ErrorResponse struct

+ Error APIError

+ type Function struct

+ Description string

+ Name string

+ Parameters map[string]interface{}

+ type FunctionCall struct

+ Arguments string

+ Name string

+ type GetKeyByHashResponse struct

+ Data APIKey

+ type ImageURL struct

+ Detail string

+ URL string

+ type JSONSchema struct

+ Name string

+ Schema map[string]interface{}

+ Strict bool

+ type KeyData struct

+ IsFreeTier bool

+ IsProvisioningKey bool

+ Label string

+ Limit *float64

+ LimitRemaining *float64

+ RateLimit *KeyRateLimit

+ Usage float64

+ type KeyRateLimit struct

+ Interval string

+ Requests float64

+ type KeyResponse struct

+ Data KeyData

+ type ListKeysOptions struct

+ IncludeDisabled *bool

+ Offset *int

+ type ListKeysResponse struct

+ Data []APIKey

+ type ListModelsOptions struct

+ Category string

+ type LogProbContent struct

+ Bytes []int

+ LogProb float64

+ Token string

+ TopLogProbs []TopLogProb

+ type LogProbs struct

+ Content []LogProbContent

+ type MaxPrice struct

+ Completion float64

+ Image float64

+ Prompt float64

+ Request float64

+ type Message struct

+ Annotations []Annotation

+ Content MessageContent

+ Name string

+ Role string

+ ToolCallID string

+ ToolCalls []ToolCall

+ func CreateAssistantMessage(content string) Message

+ func CreateChatMessage(role string, content string) Message

+ func CreateMultiModalMessage(role string, text string, imageURL string) Message

+ func CreateSystemMessage(content string) Message

+ func CreateToolMessage(content string, toolCallID string) Message

+ func CreateUserMessage(content string) Message

+ type MessageContent interface

+ type Model struct

+ Architecture ModelArchitecture

+ CanonicalSlug *string

+ ContextLength *float64

+ Created float64

+ DefaultParameters *ModelDefaultParameters

+ Description string

+ HuggingFaceID *string

+ ID string

+ Name string

+ PerRequestLimits *ModelPerRequestLimits

+ Pricing ModelPricing

+ SupportedParameters []string

+ TopProvider ModelTopProvider

+ type ModelArchitecture struct

+ InputModalities []string

+ InstructType *string

+ OutputModalities []string

+ Tokenizer string

+ type ModelDefaultParameters struct

+ FrequencyPenalty *float64

+ Temperature *float64

+ TopP *float64

+ type ModelEndpoint struct

+ ContextLength float64

+ MaxCompletionTokens *float64

+ MaxPromptTokens *float64

+ Name string

+ Pricing ModelEndpointPricing

+ ProviderName string

+ Quantization *string

+ Status float64

+ SupportedParameters []string

+ UptimeLast30m *float64

+ type ModelEndpointPricing struct

+ Completion string

+ Image string

+ Prompt string

+ Request string

+ type ModelEndpointsArchitecture struct

+ InputModalities []string

+ InstructType *string

+ OutputModalities []string

+ Tokenizer *string

+ type ModelEndpointsData struct

+ Architecture ModelEndpointsArchitecture

+ Created float64

+ Description string

+ Endpoints []ModelEndpoint

+ ID string

+ Name string

+ type ModelEndpointsResponse struct

+ Data ModelEndpointsData

+ type ModelPerRequestLimits struct

+ type ModelPricing struct

+ Completion string

+ Image string

+ InputCacheRead *string

+ InputCacheWrite *string

+ InternalReasoning string

+ Prompt string

+ Request string

+ WebSearch string

+ type ModelTopProvider struct

+ ContextLength *float64

+ IsModerated bool

+ MaxCompletionTokens *float64

+ type ModelsResponse struct

+ Data []Model

+ type Plugin struct

+ Engine string

+ ID string

+ MaxResults int

+ SearchPrompt string

+ func NewWebPlugin() Plugin

+ func NewWebPluginWithOptions(engine WebSearchEngine, maxResults int, searchPrompt string) Plugin

+ type Provider struct

+ AllowFallbacks *bool

+ DataCollection string

+ Ignore []string

+ IgnoreProviders []string

+ MaxPrice *MaxPrice

+ Only []string

+ Order []string

+ ProviderParams map[string]interface{}

+ QuantizationFallback map[string]string

+ Quantizations []string

+ RequireParameters *bool

+ Sort string

+ ZDR *bool

+ type ProviderInfo struct

+ Name string

+ PrivacyPolicyURL *string

+ Slug string

+ StatusPageURL *string

+ TermsOfServiceURL *string

+ type ProvidersResponse struct

+ Data []ProviderInfo

+ type RateLimiter struct

+ func NewRateLimiter(requestsPerSecond float64, burst int) *RateLimiter

+ func (rl *RateLimiter) Close()

+ func (rl *RateLimiter) Wait(ctx context.Context) error

+ type RequestConfig interface

+ type RequestError struct

+ Code string

+ Message string

+ StatusCode int

+ Type string

+ func IsRequestError(err error) (*RequestError, bool)

+ func (e *RequestError) Error() string

+ func (e *RequestError) IsAuthenticationError() bool

+ func (e *RequestError) IsNotFoundError() bool

+ func (e *RequestError) IsPermissionError() bool

+ func (e *RequestError) IsRateLimitError() bool

+ func (e *RequestError) IsServerError() bool

+ type RequestWithProvider interface

+ type ResponseFormat struct

+ JSONSchema *JSONSchema

+ Type string

+ type RetryConfig struct

+ InitialDelay time.Duration

+ Jitter bool

+ MaxDelay time.Duration

+ MaxRetries int

+ Multiplier float64

+ RetryableError func(error) bool

+ func DefaultRetryConfig() *RetryConfig

+ type Stream struct

+ func (s *Stream[T]) Close() error

+ func (s *Stream[T]) Err() error

+ func (s *Stream[T]) Events() <-chan T

+ type StreamError struct

+ Err error

+ Message string

+ func IsStreamError(err error) (*StreamError, bool)

+ func (e *StreamError) Error() string

+ func (e *StreamError) Unwrap() error

+ type StreamEvent struct

+ Data string

+ Event string

+ ID string

+ Retry *time.Duration

+ type Tool struct

+ Function Function

+ Type string

+ type ToolCall struct

+ Function FunctionCall

+ ID string

+ Type string

+ type TopLogProb struct

+ Bytes []int

+ LogProb float64

+ Token string

+ type URLCitation struct

+ Content string

+ EndIndex int

+ StartIndex int

+ Title string

+ URL string

+ func ParseAnnotations(annotations []Annotation) []URLCitation

+ type UpdateKeyRequest struct

+ Disabled *bool

+ IncludeBYOKInLimit *bool

+ Limit *float64

+ Name *string

+ type UpdateKeyResponse struct

+ Data APIKey

+ type Usage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

+ type ValidationError struct

+ Field string

+ Message string

+ func IsValidationError(err error) (*ValidationError, bool)

+ func (e *ValidationError) Error() string

+ type WebSearchContextSize string

+ const WebSearchContextHigh

+ const WebSearchContextLow

+ const WebSearchContextMedium

+ type WebSearchEngine string

+ const WebSearchEngineAuto

+ const WebSearchEngineExa

+ const WebSearchEngineNative

+ type WebSearchOptions struct

+ SearchContextSize string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL