openingrouter

package module

Go to main page

Versions in this module

v1

v1.1.4

Aug 24, 2026

Changes in this version

type Client

+ func (c *Client) GetModelEndpoints(ctx context.Context, slug string) (*ModelEndpoints, error)

+ type EndpointLatencyStats struct

+ P50 float64

+ P75 float64

+ P90 float64

+ P99 float64

+ type EndpointThroughputStats struct

+ P50 float64

+ P75 float64

+ P90 float64

+ P99 float64

+ type FrontendProvider struct

+ AdapterName string

+ BYOKEnabled bool

+ BaseURL string

+ DataPolicy *FrontendDataPolicy

+ Datacenters []string

+ DisplayName string

+ HasChatCompletions bool

+ HasCompletions bool

+ Headquarters string

+ Icon *FrontendIcon

+ IsAbortable bool

+ ModerationRequired bool

+ Name string

+ PricingStrategy string

+ SendClientIP bool

+ Slug string

+ StatusPageURL *string

+ func ListFrontendProviders(ctx context.Context) ([]FrontendProvider, error)

+ type ModelEndpoint struct

+ ContextLength int

+ LatencyLast30m *EndpointLatencyStats

+ MaxCompletionTokens *int

+ MaxPromptTokens *int

+ ModelID string

+ ModelName string

+ Name string

+ Pricing ModelPricing

+ ProviderName string

+ Quantization Quantization

+ Status int

+ SupportedParameters []Parameter

+ SupportsImplicitCaching bool

+ SupportsVoiceCloning bool

+ Tag string

+ ThroughputLast30m *EndpointThroughputStats

+ UptimeLast1d *float64

+ UptimeLast30m *float64

+ UptimeLast5m *float64

+ type ModelEndpoints struct

+ Architecture ModelArchitecture

+ Created int64

+ Description string

+ Endpoints []ModelEndpoint

+ ID string

+ Name string

v1.1.3

Aug 19, 2026

v1.1.2

Aug 19, 2026

Changes in this version

type OpenAICompatibleClient

+ CreateCompletion func(ctx context.Context, request CompletionRequest) (*CompletionResponse, error)

+ CreateCompletionStream func(ctx context.Context, request CompletionRequest) (OpenrouterStream[CompletionStreamChunk], error)

+ CreateEmbeddings func(ctx context.Context, request EmbeddingRequest) (*EmbeddingResponse, error)

v1.1.1

Aug 19, 2026

Changes in this version

+ type OpenAICompatibleClient interface

+ CreateChatCompletion func(ctx context.Context, request ChatCompletionRequest) (*ChatCompletionResponse, error)

+ CreateChatCompletionStream func(ctx context.Context, request ChatCompletionRequest) (OpenrouterStream[ChatStreamChunk], error)

+ Do func(req *http.Request) (*http.Response, error)

+ ListModels func(ctx context.Context, options *ListModelsOptions) ([]Model, error)

+ NewRequest func(ctx context.Context, method, path string, data any) (*http.Request, error)

v1.1.0

Aug 19, 2026

Changes in this version

+ func AsOpenAIError(resp *http.Response, err error) error

type Client

+ func (c *Client) ToOpenAI(options ...OpenAIOption) *OpenAIClient

+ type CompletionChoice struct

+ FinishReason string

+ Index int

+ Logprobs *CompletionLogprobs

+ Text string

+ type CompletionInput struct

+ Text string

+ Texts []string

+ TokenArrays [][]int

+ Tokens []int

+ func (ci CompletionInput) MarshalJSON() ([]byte, error)

+ type CompletionLogprobs struct

+ TextOffset []int

+ TokenLogprobs []float64

+ Tokens []string

+ TopLogprobs []map[string]float64

+ type CompletionObject string

+ const CompletionObjectTextCompletion

+ type CompletionRequest struct

+ BestOf *int

+ Echo *bool

+ FrequencyPenalty *float64

+ LogitBias map[string]float64

+ Logprobs *int

+ MaxTokens *int

+ Model string

+ N *int

+ PresencePenalty *float64

+ Prompt CompletionInput

+ Seed *int

+ Stop []string

+ Stream *bool

+ StreamOptions *ChatStreamOptions

+ Suffix string

+ Temperature *float64

+ TopP *float64

+ User string

+ type CompletionResponse struct

+ Choices []CompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object CompletionObject

+ SystemFingerprint *string

+ Usage *CompletionUsage

+ type CompletionStreamChoice struct

+ FinishReason *string

+ Index int

+ Logprobs *CompletionLogprobs

+ Text string

+ type CompletionStreamChunk struct

+ Choices []CompletionStreamChoice

+ Created int64

+ ID string

+ Model string

+ Object CompletionObject

+ SystemFingerprint *string

+ Usage *CompletionUsage

+ type CompletionUsage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

+ type OpenAIClient struct

+ func NewOpenAIClient(token string, options ...OpenAIOption) *OpenAIClient

+ func (c *OpenAIClient) CreateChatCompletion(ctx context.Context, request ChatCompletionRequest) (*ChatCompletionResponse, error)

+ func (c *OpenAIClient) CreateChatCompletionStream(ctx context.Context, request ChatCompletionRequest) (OpenrouterStream[ChatStreamChunk], error)

+ func (c *OpenAIClient) CreateCompletion(ctx context.Context, request CompletionRequest) (*CompletionResponse, error)

+ func (c *OpenAIClient) CreateCompletionStream(ctx context.Context, request CompletionRequest) (OpenrouterStream[CompletionStreamChunk], error)

+ func (c *OpenAIClient) CreateEmbeddings(ctx context.Context, request EmbeddingRequest) (*EmbeddingResponse, error)

+ func (c *OpenAIClient) Do(req *http.Request) (*http.Response, error)

+ func (c *OpenAIClient) GetModel(ctx context.Context, model string) (*Model, error)

+ func (c *OpenAIClient) ListModels(ctx context.Context) ([]Model, error)

+ func (c *OpenAIClient) NewRequest(ctx context.Context, method, path string, data any) (*http.Request, error)

+ type OpenAIError struct

+ Code string

+ Message string

+ Param string

+ Type string

+ func (o *OpenAIError) Error() string

+ type OpenAIOption func(*OpenAIClient)

+ func WithOpenAIBase(base string) OpenAIOption

+ func WithOpenAIHTTPClient(client *http.Client) OpenAIOption

v1.0.2

Jul 31, 2026

Changes in this version

+ var ErrContextLength = errors.New("context length exceeded")

+ var ErrForbidden = errors.New("forbidden")

+ var ErrInsufficientCredits = errors.New("insufficient credits")

+ var ErrInvalidRequest = errors.New("invalid request")

+ var ErrModerated = errors.New("moderated")

+ var ErrNotFound = errors.New("not found")

+ var ErrProviderUnavailable = errors.New("provider unavailable")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrServer = errors.New("server error")

+ var ErrTimeout = errors.New("timeout")

+ var ErrUnauthorized = errors.New("unauthorized")

+ type CreditsError struct

+ LimitSource string

+ Message string

+ RemedyHint string

+ func (c *CreditsError) Error() string

+ type ErrorStatus struct

+ Code int64

+ Previous []SubError

+ ProviderCode string

+ RetryAfter time.Duration

+ Type ErrorType

+ func (s ErrorStatus) Retryable() bool

+ func (s ErrorStatus) Unwrap() error

+ type ErrorType string

+ const ErrorTypeAuthentication

+ const ErrorTypeContentPolicy

+ const ErrorTypeContextLengthExceeded

+ const ErrorTypeImageDownloadFailed

+ const ErrorTypeImageNotFound

+ const ErrorTypeImageTooLarge

+ const ErrorTypeImageTooSmall

+ const ErrorTypeInvalidImage

+ const ErrorTypeInvalidPrompt

+ const ErrorTypeInvalidRequest

+ const ErrorTypeMaxTokensExceeded

+ const ErrorTypeNotFound

+ const ErrorTypePayloadTooLarge

+ const ErrorTypePaymentRequired

+ const ErrorTypePermissionDenied

+ const ErrorTypePreconditionFailed

+ const ErrorTypeProviderOverloaded

+ const ErrorTypeProviderUnavailable

+ const ErrorTypeRateLimitExceeded

+ const ErrorTypeRefusal

+ const ErrorTypeServer

+ const ErrorTypeStringTooLong

+ const ErrorTypeTimeout

+ const ErrorTypeTokenLimitExceeded

+ const ErrorTypeUnmapped

+ const ErrorTypeUnprocessable

+ const ErrorTypeUnsupportedImage

+ type HttpError struct

+ Status string

+ func (h *HttpError) Error() string

+ type ModerationError struct

+ FlaggedInput string

+ Message string

+ ModelSlug string

+ ProviderName string

+ Reasons []string

+ func (m *ModerationError) Error() string

type OpenRouterError

+ Metadata json.RawMessage

+ type SubError struct

+ Code int64

+ Message string

+ ProviderName string

+ Raw string

v1.0.1

Jul 29, 2026

Changes in this version

type ChatMessage

+ func AssistantMessage(content string) ChatMessage

+ func SystemMessage(content string) ChatMessage

+ func ToolMessage(callID string, content string) ChatMessage

+ func UserMessage(content string) ChatMessage

+ func UserMessageWithImage(text, imageURL string) ChatMessage

v1.0.0

Jul 29, 2026

Changes in this version

+ func AsOpenRouterError(resp *http.Response, err error) error

+ func IsResponseServerSentEventsStream(response *http.Response) bool

+ type AnthropicCacheControl struct

+ TTL AnthropicCacheTTL

+ Type AnthropicCacheControlType

+ type AnthropicCacheControlType string

+ const AnthropicCacheControlTypeEphemeral

+ type AnthropicCacheCreation struct

+ Ephemeral1HInputTokens int

+ Ephemeral5MInputTokens int

+ type AnthropicCacheTTL string

+ const AnthropicCacheTTL1H

+ const AnthropicCacheTTL5M

+ type AnthropicIterationCacheCreation struct

+ Ephemeral1HInputTokens int

+ Ephemeral5MInputTokens int

+ type AnthropicSpeed string

+ const AnthropicSpeedFast

+ const AnthropicSpeedStandard

+ type AnthropicUsageIteration struct

+ CacheCreation *AnthropicIterationCacheCreation

+ CacheCreationInputTokens int

+ CacheReadInputTokens int

+ InputTokens int

+ Model string

+ OutputTokens int

+ Type AnthropicUsageIterationType

+ type AnthropicUsageIterationType string

+ const AnthropicUsageIterationTypeAdvisorMessage

+ const AnthropicUsageIterationTypeCompaction

+ const AnthropicUsageIterationTypeMessage

+ type ApiError struct

+ Message string

+ Name string

+ func (a *ApiError) Error() string

+ type ApiKeyInfo struct

+ BYOKUsage float64

+ BYOKUsageDaily float64

+ BYOKUsageMonthly float64

+ BYOKUsageWeekly float64

+ CreatorUserID *string

+ ExpiresAt *FlexibleTime

+ IncludeBYOKInLimit bool

+ IsFreeTier bool

+ IsManagementKey bool

+ IsProvisioningKey bool

+ Label string

+ Limit *float64

+ LimitRemaining *float64

+ LimitReset *ApiKeyLimitReset

+ RateLimit ApiKeyRateLimit

+ Usage float64

+ UsageDaily float64

+ UsageMonthly float64

+ UsageWeekly float64

+ type ApiKeyLimitReset string

+ const ApiKeyLimitResetDaily

+ const ApiKeyLimitResetMonthly

+ const ApiKeyLimitResetWeekly

+ type ApiKeyRateLimit struct

+ Interval string

+ Note string

+ Requests int

+ type ArtificialAnalysisBenchmark struct

+ AgenticIndex *float64

+ CodingIndex *float64

+ IntelligenceIndex *float64

+ type ChatAdvisorTool struct

+ Parameters *ChatAdvisorToolConfig

+ Type ChatToolType

+ type ChatAdvisorToolConfig struct

+ ForwardTranscript *bool

+ Instructions string

+ MaxCompletionTokens *int

+ MaxToolCalls *int

+ Model string

+ Name string

+ Reasoning *ChatToolReasoning

+ Stream *bool

+ Temperature *float64

+ Tools []ChatNestedTool

+ type ChatAssistantImage struct

+ ImageURL ContentPartImageURL

+ type ChatAudioOutput struct

+ Data string

+ ExpiresAt int64

+ ID string

+ Transcript string

+ type ChatAutoBetaRouterPlugin struct

+ AllowedModels []string

+ CostQualityTradeoff *int

+ CostTier ChatCostTier

+ Enabled *bool

+ ID ChatPluginID

+ type ChatAutoRouterPlugin struct

+ AllowedModels []string

+ CostQualityTradeoff *int

+ CostTier ChatCostTier

+ Enabled *bool

+ ID ChatPluginID

+ PinModel *bool

+ type ChatBashEngine string

+ const ChatBashEngineAuto

+ const ChatBashEngineNative

+ const ChatBashEngineOpenRouter

+ type ChatBashEnvironment struct

+ ContainerID string

+ Type ChatBashEnvironmentType

+ type ChatBashEnvironmentType string

+ const ChatBashEnvironmentTypeContainerAuto

+ const ChatBashEnvironmentTypeContainerReference

+ type ChatBashTool struct

+ Parameters *ChatBashToolConfig

+ Type ChatToolType

+ type ChatBashToolConfig struct

+ Engine ChatBashEngine

+ Environment *ChatBashEnvironment

+ SleepAfterSeconds *int

+ type ChatChoice struct

+ FinishReason ChatFinishReason

+ Index int

+ Logprobs *ChatLogprobs

+ Message ChatMessage

+ type ChatCompletionRequest struct

+ CacheControl *AnthropicCacheControl

+ Debug *ChatDebugOptions

+ FrequencyPenalty *float64

+ ImageConfig ChatImageConfig

+ LogitBias map[string]float64

+ Logprobs *bool

+ MaxCompletionTokens *int

+ MaxTokens *int

+ Messages []ChatMessage

+ Metadata map[string]string

+ MetadataLevel ChatMetadataLevel

+ MinP *float64

+ Modalities []OutputModality

+ Model string

+ Models []string

+ ParallelToolCalls *bool

+ Plugins []ChatPlugin

+ Prediction *ChatPrediction

+ PresencePenalty *float64

+ PromptCacheKey string

+ PromptCacheOptions *ChatPromptCacheOptions

+ Provider *ProviderPreferences

+ Reasoning *ChatReasoningConfig

+ ReasoningEffort ReasoningEffort

+ RepetitionPenalty *float64

+ ResponseFormat *ChatResponseFormat

+ Route ChatRoute

+ Seed *int

+ ServiceTier ChatServiceTier

+ SessionID string

+ Stop []string

+ StopServerToolsWhen []ChatStopCondition

+ Stream *bool

+ StreamOptions *ChatStreamOptions

+ Temperature *float64

+ ToolChoice *ChatToolChoice

+ Tools []ChatTool

+ TopA *float64

+ TopK *int

+ TopLogprobs *int

+ TopP *float64

+ Trace *ChatTraceConfig

+ User string

+ type ChatCompletionResponse struct

+ Choices []ChatChoice

+ Created int64

+ ID string

+ Model string

+ Object ChatObject

+ OpenRouterMetadata *OpenRouterMetadata

+ ServiceTier *string

+ SystemFingerprint *string

+ Usage *ChatUsage

+ type ChatCompletionTokensDetails struct

+ AcceptedPredictionTokens *int

+ AudioTokens *int

+ ReasoningTokens *int

+ RejectedPredictionTokens *int

+ type ChatContent struct

+ Parts []ChatContentPart

+ Text string

+ func (cc *ChatContent) UnmarshalJSON(data []byte) error

+ func (cc ChatContent) MarshalJSON() ([]byte, error)

+ func (cc ChatContent) String() string

+ type ChatContentFile struct

+ FileData string

+ FileID string

+ Filename string

+ type ChatContentImageURL struct

+ Detail ChatImageDetail

+ URL string

+ type ChatContentInputAudio struct

+ Data string

+ Format string

+ type ChatContentPart struct

+ CacheControl *AnthropicCacheControl

+ File *ChatContentFile

+ ImageURL *ChatContentImageURL

+ InputAudio *ChatContentInputAudio

+ PromptCacheBreakpoint *ChatPromptCacheBreakpoint

+ Text string

+ Type ChatContentPartType

+ VideoURL *ChatContentVideoURL

+ type ChatContentPartType string

+ const ChatContentPartTypeFile

+ const ChatContentPartTypeImageURL

+ const ChatContentPartTypeInputAudio

+ const ChatContentPartTypeInputVideo

+ const ChatContentPartTypeText

+ const ChatContentPartTypeVideoURL

+ type ChatContentVideoURL struct

+ URL string

+ type ChatContextCompressionEngine string

+ const ChatContextCompressionEngineMiddleOut

+ type ChatContextCompressionPlugin struct

+ Enabled *bool

+ Engine ChatContextCompressionEngine

+ ID ChatPluginID

+ type ChatCostTier string

+ const ChatCostTierHigh

+ const ChatCostTierLow

+ const ChatCostTierMax

+ const ChatCostTierMedium

+ const ChatCostTierXHigh

+ type ChatDatetimeTool struct

+ Parameters *ChatDatetimeToolConfig

+ Type ChatToolType

+ type ChatDatetimeToolConfig struct

+ Timezone string

+ type ChatDebugOptions struct

+ EchoUpstreamBody bool

+ type ChatErrorType string

+ const ChatErrorTypeAuthentication

+ const ChatErrorTypeContentPolicyViolation

+ const ChatErrorTypeContextLengthExceeded

+ const ChatErrorTypeImageDownloadFailed

+ const ChatErrorTypeImageNotFound

+ const ChatErrorTypeImageTooLarge

+ const ChatErrorTypeImageTooSmall

+ const ChatErrorTypeInvalidImage

+ const ChatErrorTypeInvalidPrompt

+ const ChatErrorTypeInvalidRequest

+ const ChatErrorTypeMaxTokensExceeded

+ const ChatErrorTypeNotFound

+ const ChatErrorTypePayloadTooLarge

+ const ChatErrorTypePaymentRequired

+ const ChatErrorTypePermissionDenied

+ const ChatErrorTypePreconditionFailed

+ const ChatErrorTypeProviderOverloaded

+ const ChatErrorTypeProviderUnavailable

+ const ChatErrorTypeRateLimitExceeded

+ const ChatErrorTypeRefusal

+ const ChatErrorTypeServer

+ const ChatErrorTypeStringTooLong

+ const ChatErrorTypeTimeout

+ const ChatErrorTypeTokenLimitExceeded

+ const ChatErrorTypeUnmapped

+ const ChatErrorTypeUnprocessable

+ const ChatErrorTypeUnsupportedImageFormat

+ type ChatFileParserPlugin struct

+ Enabled *bool

+ ID ChatPluginID

+ PDF *ChatPDFParserOptions

+ type ChatFilesTool struct

+ Parameters *ChatFilesToolConfig

+ Type ChatToolType

+ type ChatFilesToolConfig struct

+ type ChatFinishReason string

+ const ChatFinishReasonContentFilter

+ const ChatFinishReasonError

+ const ChatFinishReasonLength

+ const ChatFinishReasonStop

+ const ChatFinishReasonToolCalls

+ type ChatFunction struct

+ Description string

+ Name string

+ Parameters map[string]any

+ Strict *bool

+ type ChatFunctionTool struct

+ CacheControl *AnthropicCacheControl

+ Function ChatFunction

+ Type ChatToolType

+ type ChatFusionPlugin struct

+ AnalysisModels []string

+ Enabled *bool

+ ID ChatPluginID

+ MaxToolCalls *int

+ Model string

+ Preset ChatFusionPreset

+ Tools []ChatNestedTool

+ type ChatFusionPreset string

+ const ChatFusionPresetGeneralBudget

+ const ChatFusionPresetGeneralFast

+ const ChatFusionPresetGeneralHigh

+ type ChatFusionTool struct

+ Parameters *ChatFusionToolConfig

+ Type ChatToolType

+ type ChatFusionToolConfig struct

+ AnalysisModels []string

+ CacheControl *AnthropicCacheControl

+ MaxCompletionTokens *int

+ MaxToolCalls *int

+ Model string

+ Reasoning *ChatToolReasoning

+ Temperature *float64

+ Tools []ChatNestedTool

+ type ChatImageConfig map[string]any

+ type ChatImageDetail string

+ const ChatImageDetailAuto

+ const ChatImageDetailHigh

+ const ChatImageDetailLow

+ const ChatImageDetailOriginal

+ type ChatImageGenerationTool struct

+ Parameters ChatImageGenerationToolConfig

+ Type ChatToolType

+ type ChatImageGenerationToolConfig map[string]any

+ type ChatJSONSchema struct

+ Description string

+ Name string

+ Schema map[string]any

+ Strict *bool

+ type ChatLogprobs struct

+ Content []ChatTokenLogprob

+ Refusal []ChatTokenLogprob

+ type ChatMessage struct

+ Audio *ChatAudioOutput

+ Content ChatContent

+ Images []ChatAssistantImage

+ Model string

+ Name string

+ Reasoning string

+ ReasoningDetails []ChatReasoningDetail

+ Refusal string

+ Role ChatRole

+ ToolCallID string

+ ToolCalls []ChatToolCall

+ type ChatMetadataLevel string

+ const ChatMetadataLevelDisabled

+ const ChatMetadataLevelEnabled

+ type ChatModerationPlugin struct

+ ID ChatPluginID

+ type ChatNestedTool struct

+ Parameters map[string]any

+ Type ChatToolType

+ type ChatObject string

+ const ChatObjectCompletion

+ const ChatObjectCompletionChunk

+ type ChatPDFParserEngine string

+ const ChatPDFParserEngineCloudflareAI

+ const ChatPDFParserEngineMistralOCR

+ const ChatPDFParserEngineNative

+ const ChatPDFParserEnginePDFText

+ type ChatPDFParserOptions struct

+ Engine ChatPDFParserEngine

+ type ChatParetoPriceSource string

+ const ChatParetoPriceSourcePrompt

+ const ChatParetoPriceSourceWeightedAvg

+ type ChatParetoRouterPlugin struct

+ Enabled *bool

+ ID ChatPluginID

+ MaxPrice *float64

+ MinCodingScore *float64

+ PriceSource ChatParetoPriceSource

+ type ChatPlugin interface

+ type ChatPluginID string

+ const ChatPluginIDAutoBetaRouter

+ const ChatPluginIDAutoRouter

+ const ChatPluginIDContextCompression

+ const ChatPluginIDFileParser

+ const ChatPluginIDFusion

+ const ChatPluginIDModeration

+ const ChatPluginIDParetoRouter

+ const ChatPluginIDResponseHealing

+ const ChatPluginIDWeb

+ const ChatPluginIDWebFetch

+ type ChatPrediction struct

+ Content ChatContent

+ Type ChatPredictionType

+ type ChatPredictionType string

+ const ChatPredictionTypeContent

+ type ChatPromptCacheBreakpoint struct

+ Mode ChatPromptCacheMode

+ type ChatPromptCacheMode string

+ const ChatPromptCacheModeExplicit

+ type ChatPromptCacheOptions struct

+ Mode ChatPromptCacheMode

+ TTL string

+ type ChatReasoningConfig struct

+ Effort ReasoningEffort

+ Summary ChatReasoningSummary

+ type ChatReasoningDetail struct

+ Arguments string

+ Data string

+ Format ChatReasoningFormat

+ ID string

+ Index int

+ Result string

+ Signature string

+ Summary string

+ Text string

+ ToolCallID string

+ ToolName string

+ Type ChatReasoningDetailType

+ type ChatReasoningDetailType string

+ const ChatReasoningDetailTypeEncrypted

+ const ChatReasoningDetailTypeServerToolCall

+ const ChatReasoningDetailTypeSummary

+ const ChatReasoningDetailTypeText

+ type ChatReasoningFormat string

+ const ChatReasoningFormatAnthropicClaudeV1

+ const ChatReasoningFormatAzureOpenAIResponsesV1

+ const ChatReasoningFormatBedrockOpenAIResponsesV1

+ const ChatReasoningFormatGoogleGeminiV1

+ const ChatReasoningFormatMetaResponsesV1

+ const ChatReasoningFormatOpenAIResponsesV1

+ const ChatReasoningFormatUnknown

+ const ChatReasoningFormatXAIResponsesV1

+ type ChatReasoningSummary string

+ const ChatReasoningSummaryAuto

+ const ChatReasoningSummaryConcise

+ const ChatReasoningSummaryDetailed

+ type ChatResponseFormat struct

+ Grammar string

+ JSONSchema *ChatJSONSchema

+ Type ChatResponseFormatType

+ type ChatResponseFormatType string

+ const ChatResponseFormatTypeGrammar

+ const ChatResponseFormatTypeJSONObject

+ const ChatResponseFormatTypeJSONSchema

+ const ChatResponseFormatTypePython

+ const ChatResponseFormatTypeText

+ type ChatResponseHealingPlugin struct

+ Enabled *bool

+ ID ChatPluginID

+ type ChatRole string

+ const ChatRoleAssistant

+ const ChatRoleDeveloper

+ const ChatRoleSystem

+ const ChatRoleTool

+ const ChatRoleUser

+ type ChatRoute string

+ const ChatRouteFallback

+ const ChatRouteSort

+ type ChatSearchContextSize string

+ const ChatSearchContextSizeHigh

+ const ChatSearchContextSizeLow

+ const ChatSearchContextSizeMedium

+ type ChatSearchModelsTool struct

+ Parameters *ChatSearchModelsToolConfig

+ Type ChatToolType

+ type ChatSearchModelsToolConfig struct

+ MaxResults *int

+ type ChatServiceTier string

+ const ChatServiceTierAuto

+ const ChatServiceTierDefault

+ const ChatServiceTierFlex

+ const ChatServiceTierPriority

+ const ChatServiceTierScale

+ type ChatStopCondition struct

+ MaxCostInDollars *float64

+ MaxTokens *int

+ Reason string

+ StepCount *int

+ ToolName string

+ Type ChatStopConditionType

+ type ChatStopConditionType string

+ const ChatStopConditionTypeFinishReasonIs

+ const ChatStopConditionTypeHasToolCall

+ const ChatStopConditionTypeMaxCost

+ const ChatStopConditionTypeMaxTokensUsed

+ const ChatStopConditionTypeStepCountIs

+ type ChatStreamChoice struct

+ Delta ChatStreamDelta

+ FinishReason ChatFinishReason

+ Index int

+ Logprobs *ChatLogprobs

+ type ChatStreamChunk struct

+ Choices []ChatStreamChoice

+ Created int64

+ Error *ChatStreamError

+ ID string

+ Model string

+ Object ChatObject

+ OpenRouterMetadata *OpenRouterMetadata

+ ServiceTier *string

+ SystemFingerprint string

+ Usage *ChatUsage

+ type ChatStreamDelta struct

+ Audio *ChatAudioOutput

+ Content string

+ Images []ChatAssistantImage

+ Reasoning string

+ ReasoningDetails []ChatReasoningDetail

+ Refusal string

+ Role ChatRole

+ ToolCalls []ChatStreamToolCall

+ type ChatStreamError struct

+ Code int64

+ Message string

+ Metadata *ChatStreamErrorMetadata

+ func (e *ChatStreamError) Error() string

+ type ChatStreamErrorMetadata struct

+ ErrorType ChatErrorType

+ ProviderCode string

+ type ChatStreamOptions struct

+ IncludeUsage *bool

+ type ChatStreamToolCall struct

+ Function *ChatStreamToolCallFunction

+ ID string

+ Index int

+ Type ChatToolType

+ type ChatStreamToolCallFunction struct

+ Arguments string

+ Name string

+ type ChatSubagentTool struct

+ Parameters *ChatSubagentToolConfig

+ Type ChatToolType

+ type ChatSubagentToolConfig struct

+ Instructions string

+ MaxCompletionTokens *int

+ MaxToolCalls *int

+ Model string

+ Name string

+ Reasoning *ChatToolReasoning

+ Temperature *float64

+ Tools []ChatNestedTool

+ type ChatTokenLogprob struct

+ Bytes []int

+ Logprob float64

+ Token string

+ TopLogprobs []ChatTopLogprob

+ type ChatTool interface

+ type ChatToolCall struct

+ Function ChatToolCallFunction

+ ID string

+ Type ChatToolType

+ type ChatToolCallFunction struct

+ Arguments string

+ Name string

+ type ChatToolChoice struct

+ Function *ChatToolChoiceFunction

+ Mode ChatToolChoiceMode

+ Type ChatToolType

+ func (tc ChatToolChoice) MarshalJSON() ([]byte, error)

+ type ChatToolChoiceFunction struct

+ Name string

+ type ChatToolChoiceMode string

+ const ChatToolChoiceModeAuto

+ const ChatToolChoiceModeNone

+ const ChatToolChoiceModeRequired

+ type ChatToolReasoning struct

+ Effort ReasoningEffort

+ MaxTokens *int

+ type ChatToolType string

+ const ChatToolTypeAdvisor

+ const ChatToolTypeBash

+ const ChatToolTypeDatetime

+ const ChatToolTypeFiles

+ const ChatToolTypeFunction

+ const ChatToolTypeFusion

+ const ChatToolTypeImageGeneration

+ const ChatToolTypeSearchModels

+ const ChatToolTypeSubagent

+ const ChatToolTypeWebFetch

+ const ChatToolTypeWebSearch

+ const ChatToolTypeWebSearch20250826

+ const ChatToolTypeWebSearchPreview

+ const ChatToolTypeWebSearchPreview20250311

+ const ChatToolTypeWebSearchShorthand

+ type ChatTopLogprob struct

+ Bytes []int

+ Logprob float64

+ Token string

+ type ChatTraceConfig struct

+ GenerationName string

+ ParentSpanID string

+ SpanName string

+ TraceID string

+ TraceName string

+ type ChatUsage struct

+ CompletionTokens int

+ CompletionTokensDetails *ChatCompletionTokensDetails

+ Cost *float64

+ CostDetails *CostDetails

+ IsBYOK bool

+ PromptTokens int

+ PromptTokensDetails *PromptTokensDetails

+ ServerToolUseDetails *ServerToolUse

+ TotalTokens int

+ type ChatUserLocationType string

+ const ChatUserLocationTypeApproximate

+ type ChatWebFetchEngine string

+ const ChatWebFetchEngineAuto

+ const ChatWebFetchEngineExa

+ const ChatWebFetchEngineFirecrawl

+ const ChatWebFetchEngineNative

+ const ChatWebFetchEngineOpenRouter

+ const ChatWebFetchEngineParallel

+ type ChatWebFetchPlugin struct

+ AllowedDomains []string

+ BlockedDomains []string

+ ID ChatPluginID

+ MaxContentTokens *int

+ MaxUses *int

+ type ChatWebFetchTool struct

+ Parameters *ChatWebFetchToolConfig

+ Type ChatToolType

+ type ChatWebFetchToolConfig struct

+ AllowedDomains []string

+ BlockedDomains []string

+ Engine ChatWebFetchEngine

+ MaxContentTokens *int

+ MaxUses *int

+ type ChatWebSearchEngine string

+ const ChatWebSearchEngineAuto

+ const ChatWebSearchEngineExa

+ const ChatWebSearchEngineFirecrawl

+ const ChatWebSearchEngineNative

+ const ChatWebSearchEngineParallel

+ const ChatWebSearchEnginePerplexity

+ type ChatWebSearchPlugin struct

+ Enabled *bool

+ Engine ChatWebSearchEngine

+ ExcludeDomains []string

+ ID ChatPluginID

+ IncludeDomains []string

+ MaxResults *int

+ MaxUses *int

+ SearchPrompt string

+ UserLocation *ChatWebSearchUserLocation

+ type ChatWebSearchShorthandTool struct

+ AllowedDomains []string

+ Engine ChatWebSearchEngine

+ ExcludedDomains []string

+ MaxCharacters *int

+ MaxResults *int

+ MaxTotalResults *int

+ MaxUses *int

+ Parameters *ChatWebSearchToolConfig

+ SearchContextSize ChatSearchContextSize

+ Type ChatToolType

+ UserLocation *ChatWebSearchUserLocation

+ type ChatWebSearchTool struct

+ Parameters *ChatWebSearchToolConfig

+ Type ChatToolType

+ type ChatWebSearchToolConfig struct

+ AllowedDomains []string

+ Engine ChatWebSearchEngine

+ ExcludedDomains []string

+ MaxCharacters *int

+ MaxResults *int

+ MaxTotalResults *int

+ MaxUses *int

+ SearchContextSize ChatSearchContextSize

+ UserLocation *ChatWebSearchUserLocation

+ type ChatWebSearchUserLocation struct

+ City string

+ Country string

+ Region string

+ Timezone string

+ Type ChatUserLocationType

+ type Client struct

+ func NewClient(token string, options ...Option) *Client

+ func (c *Client) CreateChatCompletion(ctx context.Context, request ChatCompletionRequest) (*ChatCompletionResponse, error)

+ func (c *Client) CreateChatCompletionStream(ctx context.Context, request ChatCompletionRequest) (OpenrouterStream[ChatStreamChunk], error)

+ func (c *Client) CreateEmbeddings(ctx context.Context, request EmbeddingRequest) (*EmbeddingResponse, error)

+ func (c *Client) CreateSpeech(ctx context.Context, request SpeechRequest) (*SpeechResponse, error)

+ func (c *Client) CreateTranscription(ctx context.Context, request STTRequest) (*STTResponse, error)

+ func (c *Client) Do(req *http.Request) (*http.Response, error)

+ func (c *Client) GenerateImage(ctx context.Context, request ImageGenerationRequest) (*ImageGenerationResponse, error)

+ func (c *Client) GenerateImageStream(ctx context.Context, request ImageGenerationRequest) (OpenrouterStream[ImageStreamEvent], error)

+ func (c *Client) GetCurrentApiKey(ctx context.Context) (*ApiKeyInfo, error)

+ func (c *Client) GetModelBySlug(ctx context.Context, slug string) (*Model, error)

+ func (c *Client) ListEmbeddingModels(ctx context.Context, options *ListEmbeddingModelsOptions) ([]Model, error)

+ func (c *Client) ListImageModels(ctx context.Context) ([]ImageModel, error)

+ func (c *Client) ListModels(ctx context.Context, options *ListModelsOptions) ([]Model, error)

+ func (c *Client) ListUserModels(ctx context.Context, options *ListUserModelsOptions) ([]Model, error)

+ func (c *Client) NewRequest(ctx context.Context, method, path string, data any) (*http.Request, error)

+ type CompletionTokensDetails struct

+ AudioTokens *int

+ ImageTokens *int

+ ReasoningTokens *int

+ type ContentPartImage struct

+ ImageURL ContentPartImageURL

+ Type ContentPartType

+ type ContentPartImageURL struct

+ URL string

+ type ContentPartType string

+ const ContentPartTypeImageURL

+ type CostDetails struct

+ UpstreamInferenceCompletionsCost float64

+ UpstreamInferenceCost *float64

+ UpstreamInferencePromptCost float64

+ type DesignArenaBenchmark struct

+ Arena string

+ Category string

+ ELO float64

+ Rank int

+ WinRate float64

+ type Embedding struct

+ Embedding EmbeddingValue

+ Index int

+ Object EmbeddingObject

+ type EmbeddingContentPart struct

+ ImageURL *ContentPartImageURL

+ InputAudio *EmbeddingMedia

+ InputFile *EmbeddingMedia

+ InputVideo *EmbeddingMedia

+ Text string

+ Type EmbeddingContentPartType

+ type EmbeddingContentPartType string

+ const EmbeddingContentPartTypeImageURL

+ const EmbeddingContentPartTypeInputAudio

+ const EmbeddingContentPartTypeInputFile

+ const EmbeddingContentPartTypeInputVideo

+ const EmbeddingContentPartTypeText

+ type EmbeddingEncodingFormat string

+ const EmbeddingEncodingFormatBase64

+ const EmbeddingEncodingFormatFloat

+ type EmbeddingInput struct

+ MultimodalInputs []EmbeddingMultimodalInput

+ Text string

+ Texts []string

+ TokenArrays [][]int

+ Tokens []int

+ func (ei *EmbeddingInput) UnmarshalJSON(data []byte) error

+ func (ei EmbeddingInput) MarshalJSON() ([]byte, error)

+ type EmbeddingMedia struct

+ Data string

+ Format string

+ type EmbeddingMultimodalInput struct

+ Content []EmbeddingContentPart

+ type EmbeddingObject string

+ const EmbeddingObjectEmbedding

+ const EmbeddingObjectList

+ type EmbeddingPromptTokensDetails struct

+ AudioTokens *int

+ FileTokens *int

+ ImageTokens *int

+ TextTokens *int

+ VideoTokens *int

+ type EmbeddingRequest struct

+ Dimensions *int

+ EncodingFormat EmbeddingEncodingFormat

+ Input EmbeddingInput

+ InputType string

+ Model string

+ Provider *ProviderPreferences

+ User string

+ type EmbeddingResponse struct

+ Data []Embedding

+ ID string

+ Model string

+ Object EmbeddingObject

+ Usage *EmbeddingUsage

+ type EmbeddingUsage struct

+ Cost *float64

+ CostDetails *CostDetails

+ IsBYOK bool

+ PromptTokens int

+ PromptTokensDetails *EmbeddingPromptTokensDetails

+ TotalTokens int

+ type EmbeddingValue struct

+ Base64 string

+ Floats []float64

+ func (ev *EmbeddingValue) UnmarshalJSON(data []byte) error

+ func (ev EmbeddingValue) MarshalJSON() ([]byte, error)

+ type EndpointInfo struct

+ Model string

+ Provider string

+ Selected bool

+ type EndpointsMetadata struct

+ Available []EndpointInfo

+ Total int

+ type GeneratedImage struct

+ B64JSON string

+ MediaType string

+ type ImageAspectRatio string

+ const ImageAspectRatio16x9

+ const ImageAspectRatio19Point5x9

+ const ImageAspectRatio1x1

+ const ImageAspectRatio1x2

+ const ImageAspectRatio1x4

+ const ImageAspectRatio1x8

+ const ImageAspectRatio20x9

+ const ImageAspectRatio21x9

+ const ImageAspectRatio2x1

+ const ImageAspectRatio2x3

+ const ImageAspectRatio3x2

+ const ImageAspectRatio3x4

+ const ImageAspectRatio4x1

+ const ImageAspectRatio4x3

+ const ImageAspectRatio4x5

+ const ImageAspectRatio5x4

+ const ImageAspectRatio8x1

+ const ImageAspectRatio9x16

+ const ImageAspectRatio9x19Point5

+ const ImageAspectRatio9x20

+ const ImageAspectRatio9x21

+ const ImageAspectRatioAuto

+ type ImageBackground string

+ const ImageBackgroundAuto

+ const ImageBackgroundOpaque

+ const ImageBackgroundTransparent

+ type ImageCapability struct

+ Max *float64

+ Min *float64

+ Type ImageCapabilityType

+ Values []string

+ type ImageCapabilityType string

+ const ImageCapabilityTypeBoolean

+ const ImageCapabilityTypeEnum

+ const ImageCapabilityTypeRange

+ type ImageGenerationRequest struct

+ AspectRatio ImageAspectRatio

+ Background ImageBackground

+ Count *int

+ InputReferences []ContentPartImage

+ Model string

+ OutputCompression *int

+ OutputFormat ImageOutputFormat

+ Prompt string

+ Provider *ProviderPreferences

+ Quality ImageQuality

+ Resolution ImageResolution

+ Seed *int

+ Size string

+ Stream *bool

+ type ImageGenerationResponse struct

+ Created int64

+ Data []GeneratedImage

+ Usage *Usage

+ type ImageModel struct

+ Architecture ImageModelArchitecture

+ Created int64

+ Description string

+ Endpoints string

+ ID string

+ Name string

+ SupportedParameters ImageSupportedParameters

+ SupportsStreaming bool

+ type ImageModelArchitecture struct

+ InputModalities []InputModality

+ OutputModalities []OutputModality

+ type ImageOutputFormat string

+ const ImageOutputFormatJPEG

+ const ImageOutputFormatPNG

+ const ImageOutputFormatSVG

+ const ImageOutputFormatWebP

+ type ImageQuality string

+ const ImageQualityAuto

+ const ImageQualityHigh

+ const ImageQualityLow

+ const ImageQualityMedium

+ type ImageResolution string

+ const ImageResolution1K

+ const ImageResolution2K

+ const ImageResolution4K

+ const ImageResolution512

+ type ImageStreamError struct

+ Code *string

+ Message string

+ Param *string

+ Type *string

+ func (e *ImageStreamError) Error() string

+ type ImageStreamEvent struct

+ B64JSON string

+ Created int64

+ Error *ImageStreamError

+ MediaType string

+ PartialImageIndex int

+ Phase ImageStreamPhase

+ Text string

+ Type ImageStreamEventType

+ Usage *Usage

+ type ImageStreamEventType string

+ const ImageStreamEventTypeCompleted

+ const ImageStreamEventTypeError

+ const ImageStreamEventTypePartialImage

+ const ImageStreamEventTypeTextChunk

+ type ImageStreamPhase string

+ const ImageStreamPhaseContent

+ const ImageStreamPhaseDraft

+ const ImageStreamPhaseReasoning

+ type ImageSupportedParameters map[string]ImageCapability

+ type InputModality string

+ const InputModalityAudio

+ const InputModalityFile

+ const InputModalityImage

+ const InputModalityText

+ const InputModalityVideo

+ type InstructType string

+ const InstructTypeAiroboros

+ const InstructTypeAlpaca

+ const InstructTypeAlpacaModif

+ const InstructTypeChatML

+ const InstructTypeClaude

+ const InstructTypeCodeLlama

+ const InstructTypeDeepSeekR1

+ const InstructTypeDeepSeekV31

+ const InstructTypeGemma

+ const InstructTypeLlama2

+ const InstructTypeLlama3

+ const InstructTypeMistral

+ const InstructTypeNemotron

+ const InstructTypeNeural

+ const InstructTypeNone

+ const InstructTypeOpenChat

+ const InstructTypePhi3

+ const InstructTypeQwQ

+ const InstructTypeQwen3

+ const InstructTypeRWKV

+ const InstructTypeVicuna

+ const InstructTypeZephyr

+ type JsonResponseStream struct

+ func NewJsonResponseStream[T any](chunks ...T) *JsonResponseStream[T]

+ func (s *JsonResponseStream[T]) Add(chunks ...T)

+ func (s *JsonResponseStream[T]) Close()

+ func (s *JsonResponseStream[T]) Recv() (T, error)

+ type ListEmbeddingModelsOptions struct

+ Limit *int

+ Offset *int

+ type ListModelsOptions struct

+ Architecture string

+ Category ModelCategory

+ Context *int

+ Distillable *bool

+ InputModalities []InputModality

+ Limit *int

+ MaxAgeDays *int

+ MaxAgenticIndex *float64

+ MaxCodingIndex *float64

+ MaxIntelligenceIndex *float64

+ MaxOutputPrice *float64

+ MaxPrice *float64

+ MaxToolSuccessRate *float64

+ MinAgeDays *int

+ MinAgenticIndex *float64

+ MinCodingIndex *float64

+ MinIntelligenceIndex *float64

+ MinOutputPrice *float64

+ MinPrice *float64

+ MinToolSuccessRate *float64

+ ModelAuthors []string

+ Offset *int

+ OutputModalities []OutputModality

+ Providers []string

+ Region ModelRegion

+ Search string

+ Sort ModelSort

+ SupportedParameters []Parameter

+ ZDR bool

+ type ListUserModelsOptions struct

+ Limit *int

+ Offset *int

+ type Model struct

+ Architecture ModelArchitecture

+ Benchmarks *ModelBenchmarks

+ CanonicalSlug string

+ ContextLength *int

+ Created int64

+ DefaultParameters *ModelDefaultParameters

+ Description string

+ ExpirationDate *FlexibleTime

+ HuggingFaceID *string

+ ID string

+ KnowledgeCutoff *FlexibleTime

+ Links ModelLinks

+ Name string

+ PerRequestLimits *ModelPerRequestLimits

+ Pricing ModelPricing

+ Reasoning *ModelReasoning

+ SupportedParameters []Parameter

+ SupportedVoices []string

+ TopProvider ModelTopProvider

+ type ModelArchitecture struct

+ InputModalities []InputModality

+ InstructType *InstructType

+ Modality *string

+ OutputModalities []OutputModality

+ Tokenizer ModelGroup

+ type ModelBenchmarks struct

+ ArtificialAnalysis *ArtificialAnalysisBenchmark

+ DesignArena []DesignArenaBenchmark

+ type ModelCategory string

+ const ModelCategoryAcademia

+ const ModelCategoryFinance

+ const ModelCategoryHealth

+ const ModelCategoryLegal

+ const ModelCategoryMarketing

+ const ModelCategoryMarketingSEO

+ const ModelCategoryProgramming

+ const ModelCategoryRoleplay

+ const ModelCategoryScience

+ const ModelCategoryTechnology

+ const ModelCategoryTranslation

+ const ModelCategoryTrivia

+ type ModelDefaultParameters struct

+ FrequencyPenalty *float64

+ PresencePenalty *float64

+ RepetitionPenalty *float64

+ Temperature *float64

+ TopK *int

+ TopP *float64

+ type ModelGroup string

+ const ModelGroupClaude

+ const ModelGroupCohere

+ const ModelGroupDeepSeek

+ const ModelGroupGPT

+ const ModelGroupGemini

+ const ModelGroupGemma

+ const ModelGroupGrok

+ const ModelGroupLlama2

+ const ModelGroupLlama3

+ const ModelGroupLlama4

+ const ModelGroupMedia

+ const ModelGroupMistral

+ const ModelGroupNova

+ const ModelGroupOther

+ const ModelGroupPaLM

+ const ModelGroupQwen

+ const ModelGroupQwen3

+ const ModelGroupRWKV

+ const ModelGroupRouter

+ const ModelGroupYi

+ type ModelLinks struct

+ Details string

+ type ModelPerRequestLimits struct

+ CompletionTokens StringifiedNumber

+ PromptTokens StringifiedNumber

+ type ModelPricing struct

+ Audio StringifiedNumber

+ AudioOutput StringifiedNumber

+ Completion StringifiedNumber

+ Discount float64

+ Image StringifiedNumber

+ ImageOutput StringifiedNumber

+ ImageToken StringifiedNumber

+ InputAudioCache StringifiedNumber

+ InputCacheRead StringifiedNumber

+ InputCacheWrite StringifiedNumber

+ InputCacheWrite1H StringifiedNumber

+ InternalReasoning StringifiedNumber

+ Overrides []ModelPricingOverride

+ Prompt StringifiedNumber

+ Request StringifiedNumber

+ WebSearch StringifiedNumber

+ type ModelPricingOverride struct

+ Audio StringifiedNumber

+ Completion StringifiedNumber

+ InputAudioCache StringifiedNumber

+ InputCacheRead StringifiedNumber

+ InputCacheWrite StringifiedNumber

+ InputCacheWrite1H StringifiedNumber

+ MinPromptTokens *float64

+ Prompt StringifiedNumber

+ UTCEnd *float64

+ UTCStart *float64

+ type ModelReasoning struct

+ DefaultEffort *ReasoningEffort

+ DefaultEnabled *bool

+ Mandatory bool

+ SupportedEfforts []ReasoningEffort

+ SupportsMaxTokens *bool

+ type ModelRegion string

+ const ModelRegionEU

+ type ModelSort string

+ const ModelSortAgenticHighToLow

+ const ModelSortCodingHighToLow

+ const ModelSortContextHighToLow

+ const ModelSortDesignArenaELOHighToLow

+ const ModelSortIntelligenceHighToLow

+ const ModelSortLatencyLowToHigh

+ const ModelSortMostPopular

+ const ModelSortNewest

+ const ModelSortPricingHighToLow

+ const ModelSortPricingLowToHigh

+ const ModelSortThroughputHighToLow

+ const ModelSortTopWeekly

+ type ModelTopProvider struct

+ ContextLength *int

+ IsModerated bool

+ MaxCompletionTokens *int

+ type OpenRouterError struct

+ Code int64

+ Message string

+ func (o *OpenRouterError) Error() string

+ type OpenRouterMetadata struct

+ Attempt int

+ Attempts []RouterAttempt

+ Endpoints EndpointsMetadata

+ IsBYOK bool

+ Params *RouterParams

+ Pipeline []PipelineStage

+ Region *string

+ Requested string

+ Strategy RoutingStrategy

+ Summary string

+ type OpenRouterResponse struct

+ Data T

+ type OpenrouterStream interface

+ Close func()

+ Recv func() (T, error)

+ type Option func(*Client)

+ func WithBase(base string) Option

+ func WithClient(client *http.Client) Option

+ func WithReferer(referer string) Option

+ func WithTitle(title string) Option

+ type OutputModality string

+ const OutputModalityAudio

+ const OutputModalityEmbeddings

+ const OutputModalityImage

+ const OutputModalityRerank

+ const OutputModalitySpeech

+ const OutputModalityText

+ const OutputModalityTranscription

+ const OutputModalityVideo

+ type Parameter string

+ const ParameterFrequencyPenalty

+ const ParameterIncludeReasoning

+ const ParameterLogitBias

+ const ParameterLogprobs

+ const ParameterMaxCompletionTokens

+ const ParameterMaxTokens

+ const ParameterMinP

+ const ParameterParallelToolCalls

+ const ParameterPrediction

+ const ParameterPresencePenalty

+ const ParameterReasoning

+ const ParameterReasoningEffort

+ const ParameterRepetitionPenalty

+ const ParameterResponseFormat

+ const ParameterSeed

+ const ParameterStop

+ const ParameterStructuredOutputs

+ const ParameterTemperature

+ const ParameterToolChoice

+ const ParameterTools

+ const ParameterTopA

+ const ParameterTopK

+ const ParameterTopLogprobs

+ const ParameterTopP

+ const ParameterVerbosity

+ const ParameterWebSearchOptions

+ type PipelineStage struct

+ CostUSD *float64

+ Data map[string]any

+ GuardrailID string

+ GuardrailScope string

+ Name string

+ Summary string

+ Type PipelineStageType

+ type PipelineStageType string

+ const PipelineStageTypeContextCompression

+ const PipelineStageTypeGuardrail

+ const PipelineStageTypePlugin

+ const PipelineStageTypeResponseHealing

+ const PipelineStageTypeServerTools

+ type PromptTokensDetails struct

+ AudioTokens *int

+ CacheWriteTokens *int

+ CachedTokens *int

+ FileTokens *int

+ VideoTokens *int

+ type ProviderDataCollection string

+ const ProviderDataCollectionAllow

+ const ProviderDataCollectionDeny

+ type ProviderError struct

+ IsBYOK bool

+ ProviderName string

+ Raw string

+ func (p *ProviderError) Error() string

+ type ProviderLatencyCutoffs struct

+ P50 *float64

+ P75 *float64

+ P90 *float64

+ P99 *float64

+ type ProviderMaxPrice struct

+ Audio StringifiedNumber

+ Completion StringifiedNumber

+ Image StringifiedNumber

+ Prompt StringifiedNumber

+ Request StringifiedNumber

+ type ProviderOptions map[string]map[string]any

+ type ProviderPreferences struct

+ AllowFallbacks *bool

+ DataCollection ProviderDataCollection

+ EnforceDistillableText *bool

+ Ignore []string

+ MaxPrice *ProviderMaxPrice

+ Only []string

+ Options ProviderOptions

+ Order []string

+ PreferredMaxLatency *ProviderLatencyCutoffs

+ PreferredMinThroughput *ProviderThroughputCutoffs

+ Quantizations []Quantization

+ RequireParameters *bool

+ Sort *ProviderSortConfig

+ ZDR *bool

+ type ProviderSort string

+ const ProviderSortExacto

+ const ProviderSortLatency

+ const ProviderSortPrice

+ const ProviderSortThroughput

+ type ProviderSortConfig struct

+ By ProviderSort

+ Partition ProviderSortPartition

+ type ProviderSortPartition string

+ const ProviderSortPartitionModel

+ const ProviderSortPartitionNone

+ type ProviderThroughputCutoffs struct

+ P50 *float64

+ P75 *float64

+ P90 *float64

+ P99 *float64

+ type Quantization string

+ const QuantizationBF16

+ const QuantizationFP16

+ const QuantizationFP32

+ const QuantizationFP4

+ const QuantizationFP6

+ const QuantizationFP8

+ const QuantizationInt4

+ const QuantizationInt8

+ const QuantizationMXFP4

+ const QuantizationMXFP8

+ const QuantizationNVFP4

+ const QuantizationUnknown

+ type ReasoningEffort string

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMax

+ const ReasoningEffortMedium

+ const ReasoningEffortMinimal

+ const ReasoningEffortNone

+ const ReasoningEffortXHigh

+ type RouterAttempt struct

+ Model string

+ Provider string

+ Status int

+ type RouterParams struct

+ QualityFloor *float64

+ ThroughputFloor *float64

+ VersionGroup string

+ type RoutingStrategy string

+ const RoutingStrategyAlias

+ const RoutingStrategyAuto

+ const RoutingStrategyBodybuilder

+ const RoutingStrategyDirect

+ const RoutingStrategyFallback

+ const RoutingStrategyFree

+ const RoutingStrategyFusion

+ const RoutingStrategyLatest

+ const RoutingStrategyPareto

+ type STTInputAudio struct

+ Data string

+ Format string

+ type STTProviderPreferences struct

+ Options ProviderOptions

+ type STTRequest struct

+ InputAudio STTInputAudio

+ Language string

+ Model string

+ Provider *STTProviderPreferences

+ ResponseFormat STTResponseFormat

+ Temperature *float64

+ TimestampGranularities []STTTimestampGranularity

+ type STTResponse struct

+ Duration *float64

+ Language string

+ Segments []STTSegment

+ Task string

+ Text string

+ Usage *STTUsage

+ Words []STTWord

+ type STTResponseFormat string

+ const STTResponseFormatJSON

+ const STTResponseFormatVerboseJSON

+ type STTSegment struct

+ AvgLogprob float64

+ CompressionRatio float64

+ End float64

+ ID int

+ NoSpeechProb float64

+ Seek int

+ Speaker *int

+ Start float64

+ Temperature float64

+ Text string

+ Tokens []int

+ type STTTimestampGranularity string

+ const STTTimestampGranularitySegment

+ const STTTimestampGranularityWord

+ type STTUsage struct

+ Cost *float64

+ InputTokens int

+ OutputTokens int

+ Seconds *float64

+ TotalTokens int

+ type STTWord struct

+ End float64

+ Speaker *int

+ Start float64

+ Word string

+ type ServerSentEventsStream struct

+ func NewServerSentEventsStream[T any](ctx context.Context, resp *http.Response) *ServerSentEventsStream[T]

+ func (s *ServerSentEventsStream[T]) Close()

+ func (s *ServerSentEventsStream[T]) Recv() (T, error)

+ type ServerToolUse struct

+ ToolCallsExecuted *int

+ ToolCallsRequested *int

+ WebSearchRequests *int

+ type SpeechProviderPreferences struct

+ Options ProviderOptions

+ type SpeechRequest struct

+ Input string

+ Model string

+ Provider *SpeechProviderPreferences

+ ResponseFormat SpeechResponseFormat

+ Speed *float64

+ Voice string

+ type SpeechResponse struct

+ Body io.ReadCloser

+ ContentType string

+ GenerationID string

+ type SpeechResponseFormat string

+ const SpeechResponseFormatMP3

+ const SpeechResponseFormatPCM

+ type Usage struct

+ CacheCreation *AnthropicCacheCreation

+ CompletionTokens int

+ CompletionTokensDetails *CompletionTokensDetails

+ Cost *float64

+ CostDetails *CostDetails

+ IsBYOK bool

+ Iterations []AnthropicUsageIteration

+ PromptTokens int

+ PromptTokensDetails *PromptTokensDetails

+ ServerToolUse *ServerToolUse

+ ServiceTier *string

+ Speed AnthropicSpeed

+ TotalTokens int

v0

v0.2.0

Jun 18, 2026

Changes in this version

type FrontendDefaultParams

+ PresencePenalty *float64

+ RepetitionPenalty *float64

+ TopK *float64

+ type FrontendDerankReason struct

+ Signal string

+ StddevsBelowMedian float64

+ Threshold float64

+ Value float64

+ type FrontendDerankResult struct

+ DerankReasons []FrontendDerankReason

+ IsDeranked bool

+ type FrontendDisplayPricing struct

+ DisplayMultiplier int

+ Kind string

+ Price string

+ SKULabel string

+ UnitLabel string

type FrontendEndpoint

+ AllowedPassthroughParameters []string

+ CapacityTPM *float64

+ CreatedAt FlexibleTime

+ DisplayPricing []FrontendDisplayPricing

+ ExcludedParameters []string

+ Fortuna *FrontendFortuna

+ IsPrivate bool

+ RoutingHeuristics *FrontendRoutingHeuristics

+ Status int

+ StatusHeuristics *FrontendStatusHeuristics

+ StatusHeuristics1d *FrontendStatusHeuristics

+ StatusHeuristics5m *FrontendStatusHeuristics

+ SupportedVideoParameters *FrontendSupportedVideoParameters

type FrontendFeatures

+ ReasoningReturnMechanism *string

+ type FrontendFortuna struct

+ BetaAlpha float64

+ BetaBeta float64

+ CapacityCeilingRPM float64

+ CapacityScore float64

+ RecentPeakRPM float64

type FrontendModel

+ AuthorDisplayName string

+ IsPrivate bool

+ KnowledgeCutoff *string

+ LimitRPD *int

+ LimitRPM *int

+ SupportedTTSVoices []string

type FrontendPricing

+ DisplayPricing []FrontendDisplayPricing

+ ImageOutput StringifiedNumber

type FrontendReasoningConfig

+ DefaultReasoningEffort *string

+ DefaultReasoningEnabled *bool

+ ReasoningReturnMechanism *string

+ type FrontendRoutingHeuristics struct

+ DerankResult *FrontendDerankResult

+ EffectiveCompletionPrice float64

+ EffectivePromptPrice float64

+ P50Latency float64

+ P50Latency30Minutes float64

+ P50Latency5Minutes float64

+ P50Throughput float64

+ P50Throughput2Hours float64

+ P50Throughput30Minutes float64

+ P50Throughput5Minutes float64

+ P75Latency30Minutes float64

+ P75Latency5Minutes float64

+ P75Throughput30Minutes float64

+ P75Throughput5Minutes float64

+ P90Latency30Minutes float64

+ P90Latency5Minutes float64

+ P90Throughput30Minutes float64

+ P90Throughput5Minutes float64

+ P99Latency30Minutes float64

+ P99Latency5Minutes float64

+ P99Throughput30Minutes float64

+ P99Throughput5Minutes float64

+ RequestCount int

+ RequestCount30Minutes int

+ RequestCount5Minutes int

+ ToolCallsFinishReasonRequestCount *int

+ ToolFinishReasonRequestSuccessRate *float64

+ type FrontendStatusHeuristics struct

+ DerankableError int

+ RateLimited int

+ Success int

+ type FrontendSupportedVideoParameters struct

+ GenerateAudio *bool

+ Seed *bool

+ SupportedAspectRatios []string

+ SupportedDurations []int

+ SupportedFrameImages []string

+ SupportedResolutions []string

+ SupportedSizes []string

v0.1.0

Jun 10, 2026

Changes in this version

+ type FlexibleTime struct

+ func (ft *FlexibleTime) UnmarshalJSON(data []byte) error

+ func (ft FlexibleTime) MarshalJSON() ([]byte, error)

+ type FrontendDataPolicy struct

+ CanPublish bool

+ PrivacyPolicyURL string

+ RequiresUserIDs bool

+ RetainsPrompts bool

+ RetentionDays *int

+ TermsOfServiceURL string

+ Training bool

+ TrainingOpenRouter bool

+ type FrontendDefaultParams struct

+ FrequencyPenalty *float64

+ Temperature *float64

+ TopP *float64

+ type FrontendEndpoint struct

+ AdapterName string

+ CanAbort bool

+ ContextLength int

+ DataPolicy *FrontendDataPolicy

+ DeprecationDate *FlexibleTime

+ Features *FrontendFeatures

+ HasChatCompletions bool

+ HasCompletions bool

+ ID string

+ IsBYOK bool

+ IsDeranked bool

+ IsDisabled bool

+ IsFree bool

+ IsHidden bool

+ LimitRPD *int

+ LimitRPM *int

+ LimitRPMCF *int

+ LineItems []FrontendLineItem

+ MaxCompletionTokens int

+ MaxPromptTokens *int

+ MaxTokensPerImage *int

+ Model *FrontendModel

+ ModelVariantPermaslug string

+ ModelVariantSlug string

+ ModerationRequired bool

+ Name string

+ Pricing *FrontendPricing

+ PricingJSON map[string]any

+ PricingVersionID string

+ ProviderDisplayName string

+ ProviderInfo *FrontendProviderInfo

+ ProviderModelID string

+ ProviderName string

+ ProviderRegion *string

+ ProviderSlug string

+ Quantization string

+ SupportedParameters []string

+ SupportsMultipart bool

+ SupportsReasoning bool

+ SupportsToolParams bool

+ VariablePricings []FrontendVariablePricing

+ Variant string

+ type FrontendFeatures struct

+ ChatTemplateConfig map[string]any

+ ReasoningConfig *FrontendReasoningConfig

+ SupportsBase64Video *bool

+ SupportsFileURLs *bool

+ SupportsInputAudio *bool

+ SupportsMultipart *bool

+ SupportsNativeWeb *bool

+ SupportsToolChoice *FrontendToolChoice

+ SupportsVideoURLs *bool

+ type FrontendIcon struct

+ URL string

+ type FrontendLineItem struct

+ Type string

+ Value string

+ type FrontendModel struct

+ Author string

+ ContextLength int

+ CreatedAt FlexibleTime

+ DefaultOrder []string

+ DefaultParameters *FrontendDefaultParams

+ DefaultStops []string

+ DefaultSystem *string

+ Description string

+ Endpoint *FrontendEndpoint

+ Features *FrontendFeatures

+ Group string

+ HFSlug string

+ HFUpdatedAt *FlexibleTime

+ HasTextOutput bool

+ Hidden bool

+ InputModalities []string

+ InstructType *string

+ IsTrainableImage *bool

+ IsTrainableText *bool

+ ModelVersionGroupID *string

+ Name string

+ OutputModalities []string

+ Permaslug string

+ PromotionMessage string

+ QuickStartExampleType string

+ ReasoningConfig *FrontendReasoningConfig

+ Router *string

+ RoutingErrorMessage string

+ ShortName string

+ Slug string

+ SupportsReasoning bool

+ UpdatedAt FlexibleTime

+ WarningMessage string

+ func ListFrontendModels(ctx context.Context) ([]FrontendModel, error)

+ type FrontendModelsResponse struct

+ Data []FrontendModel

+ type FrontendPricing struct

+ Audio StringifiedNumber

+ Completion StringifiedNumber

+ Discount float64

+ Image StringifiedNumber

+ InputAudioCache StringifiedNumber

+ InputCacheRead StringifiedNumber

+ InputCacheWrite StringifiedNumber

+ InternalReasoning StringifiedNumber

+ LineItems []FrontendLineItem

+ Prompt StringifiedNumber

+ WebSearch StringifiedNumber

+ type FrontendProviderInfo struct

+ AdapterName string

+ BYOKEnabled bool

+ BaseURL string

+ DataPolicy *FrontendDataPolicy

+ Datacenters []string

+ DisplayName string

+ Editors []string

+ HasChatCompletions bool

+ HasCompletions bool

+ Headquarters string

+ Icon *FrontendIcon

+ IgnoredProviderModels []string

+ IsAbortable bool

+ IsMultipartSupported bool

+ ModerationRequired bool

+ Name string

+ Owners []string

+ PricingStrategy string

+ RegionOverrides map[string]FrontendRegionOverride

+ SendClientIP bool

+ Slug string

+ StatusPageURL string

+ type FrontendReasoningConfig struct

+ EndToken *string

+ IsMandatoryReasoning *bool

+ StartToken *string

+ SupportedReasoningEfforts []string

+ SupportsReasoningEffort *bool

+ type FrontendRegionOverride struct

+ BaseURL string

+ type FrontendToolChoice struct

+ LiteralAuto bool

+ LiteralNone bool

+ LiteralRequired bool

+ TypeFunction bool

+ type FrontendVariablePricing struct

+ Completions StringifiedNumber

+ InputCacheRead StringifiedNumber

+ InputCacheWrite StringifiedNumber

+ Prompt StringifiedNumber

+ Threshold any

+ Type string

+ type StringifiedNumber float64

+ func (sn *StringifiedNumber) UnmarshalJSON(data []byte) error

+ func (sn StringifiedNumber) Float64() float64

+ func (sn StringifiedNumber) MarshalJSON() ([]byte, error)

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