openrouter

Documentation

Overview

Package openrouter exposes OpenRouter chat adapters. NewChat targets its OpenAI-compatible endpoint; NewMessages targets its Anthropic-compatible endpoint.

Index

• Constants
• type Chat
  • func NewChat(config ChatConfig) (*Chat, error)
• type ChatConfig
  • func (c ChatConfig) Validate() error
• type Messages
  • func NewMessages(config MessagesConfig) (*Messages, error)
• type MessagesConfig
  • func (m MessagesConfig) Validate() error

Constants

const (
	OpenAIRequestExtensionKey        = "openrouter/openai_request"
	OpenAIResponseExtensionKey       = "openrouter/openai_response"
	OpenAIStreamChunkExtensionKey    = "openrouter/openai_stream_chunk"
	AnthropicRequestExtensionKey     = "openrouter/anthropic_request"
	AnthropicResponseExtensionKey    = "openrouter/anthropic_response"
	AnthropicStreamEventExtensionKey = "openrouter/anthropic_stream_event"
)

Namespacing preserves provider-specific data without promoting it into the shared Core protocol or colliding with another provider.

const (
	// BaseURL is OpenRouter's production endpoint.
	BaseURL = "https://openrouter.ai/api/v1"

	// ModelAuto delegates per-request model selection to OpenRouter's
	// task-aware Auto Router.
	ModelAuto = "openrouter/auto"
)

const (
	// HeaderReferer is the standard HTTP Referer header used by
	// OpenRouter for app attribution / analytics. Pass your app's
	// homepage URL.
	HeaderReferer = "HTTP-Referer"

	// HeaderAppTitle is the X-Title header OpenRouter shows on
	// leaderboards / rankings. Pass your app's display name.
	HeaderAppTitle = "X-Title"
)

const (
	Provider = "OpenRouter"
)

Provider is the stable backend name for host-side attribution.

Types

type Chat

type Chat = openai.ChatCompletions

Chat implements OpenRouter's OpenAI-compatible endpoint.

func NewChat

func NewChat(config ChatConfig) (*Chat, error)

NewChat rejects an invalid provider binding before the first chat call.

type ChatConfig

type ChatConfig struct {
	APIKey         string
	DefaultOptions corechat.Options
	BaseURL        string
	AppURL         string
	AppTitle       string
	HTTPClient     *http.Client
}

ChatConfig binds provider access and defaults shared by every chat call.

func (ChatConfig) Validate

func (c ChatConfig) Validate() error

type Messages

type Messages = anthropic.Messages

Messages implements OpenRouter's Anthropic-compatible endpoint.

func NewMessages

func NewMessages(config MessagesConfig) (*Messages, error)

NewMessages rejects an invalid provider binding before the first Messages call.

type MessagesConfig

type MessagesConfig struct {
	APIKey         string
	DefaultOptions corechat.Options
	BaseURL        string
	AppURL         string
	AppTitle       string
	HTTPClient     *http.Client
}

MessagesConfig binds provider access and defaults shared by every Messages call.

func (MessagesConfig) Validate

func (m MessagesConfig) Validate() error