pluginapi

package

Go to main page

Versions in this module

v7

v7.2.89

Aug 2, 2026

v7.2.88

Aug 2, 2026

Changes in this version

type AuthParseResponse

+ Auths []AuthData

type Capabilities

+ RequestLifecyclePlugin RequestLifecyclePlugin

+ type RequestCompletion struct

+ CompletedAt time.Time

+ Error string

+ Metadata map[string]any

+ Model string

+ Outcome RequestCompletionOutcome

+ RequestID string

+ RequestedModel string

+ SourceFormat string

+ StartedAt time.Time

+ StatusCode int

+ Stream bool

+ TraceID string

+ type RequestCompletionOutcome string

+ const RequestCompletionCanceled

+ const RequestCompletionFailed

+ const RequestCompletionRejected

+ const RequestCompletionSucceeded

type RequestInterceptRequest

+ RequestID string

+ TraceID string

type RequestInterceptResponse

+ ResponseBody []byte

+ ResponseHeaders http.Header

+ StatusCode int

+ Terminate bool

+ type RequestLifecyclePlugin interface

+ HandleRequestComplete func(context.Context, RequestCompletion) error

type ResponseInterceptRequest

+ RequestID string

type StreamChunkInterceptRequest

+ RequestID string

type UsageRecord

+ Generate bool

v7.2.87

Jul 20, 2026

v7.2.62

Jul 20, 2026

v7.2.61

Jul 18, 2026

v7.2.60

Jul 16, 2026

v7.2.59

Jul 16, 2026

v7.2.58

Jul 10, 2026

v7.2.57

Jul 9, 2026

v7.2.54

Jul 9, 2026

v7.2.53

Jul 6, 2026

v7.2.52

Jul 1, 2026

v7.2.51

Jul 1, 2026

v7.2.50

Jul 1, 2026

v7.2.49

Jul 1, 2026

Changes in this version

type AuthLoginPollResponse

+ Auths []AuthData

type Capabilities

+ ModelRouter ModelRouter

+ type ModelRouteRequest struct

+ AvailableProviders []string

+ Body []byte

+ Headers http.Header

+ Metadata map[string]any

+ Plugin Metadata

+ PluginID string

+ Query url.Values

+ RequestedModel string

+ SourceFormat string

+ Stream bool

+ type ModelRouteResponse struct

+ Handled bool

+ Reason string

+ Target string

+ TargetKind ModelRouteTargetKind

+ TargetModel string

+ type ModelRouteTargetKind string

+ const ModelRouteTargetExecutor

+ const ModelRouteTargetProvider

+ const ModelRouteTargetSelf

+ type ModelRouter interface

+ RouteModel func(context.Context, ModelRouteRequest) (ModelRouteResponse, error)

v7.0.1

Jun 29, 2026

v7.0.0

Jun 16, 2026

Changes in this version

+ const SchedulerBuiltinFillFirst

+ const SchedulerBuiltinRoundRobin

+ const StreamChunkHeaderInitIndex

+ type AuthData struct

+ Attributes map[string]string

+ Disabled bool

+ FileName string

+ ID string

+ Label string

+ Metadata map[string]any

+ NextRefreshAfter time.Time

+ Prefix string

+ Provider string

+ ProxyURL string

+ StorageJSON []byte

+ type AuthLoginPollRequest struct

+ HTTPClient HostHTTPClient

+ Host HostConfigSummary

+ Metadata map[string]any

+ Provider string

+ State string

+ type AuthLoginPollResponse struct

+ Auth AuthData

+ Message string

+ Status AuthLoginStatus

+ type AuthLoginStartRequest struct

+ BaseURL string

+ HTTPClient HostHTTPClient

+ Host HostConfigSummary

+ Metadata map[string]any

+ Provider string

+ type AuthLoginStartResponse struct

+ ExpiresAt time.Time

+ Metadata map[string]any

+ Provider string

+ State string

+ URL string

+ type AuthLoginStatus string

+ const AuthLoginStatusError

+ const AuthLoginStatusPending

+ const AuthLoginStatusSuccess

+ type AuthModelRequest struct

+ Attributes map[string]string

+ AuthID string

+ AuthProvider string

+ HTTPClient HostHTTPClient

+ Host HostConfigSummary

+ Metadata map[string]any

+ Plugin Metadata

+ StorageJSON []byte

+ type AuthParseRequest struct

+ FileName string

+ Host HostConfigSummary

+ Path string

+ Provider string

+ RawJSON []byte

+ type AuthParseResponse struct

+ Auth AuthData

+ Handled bool

+ type AuthProvider interface

+ Identifier func() string

+ ParseAuth func(context.Context, AuthParseRequest) (AuthParseResponse, error)

+ PollLogin func(context.Context, AuthLoginPollRequest) (AuthLoginPollResponse, error)

+ RefreshAuth func(context.Context, AuthRefreshRequest) (AuthRefreshResponse, error)

+ StartLogin func(context.Context, AuthLoginStartRequest) (AuthLoginStartResponse, error)

+ type AuthRefreshRequest struct

+ Attributes map[string]string

+ AuthID string

+ AuthProvider string

+ HTTPClient HostHTTPClient

+ Host HostConfigSummary

+ Metadata map[string]any

+ StorageJSON []byte

+ type AuthRefreshResponse struct

+ Auth AuthData

+ NextRefreshAfter time.Time

+ type Capabilities struct

+ AuthProvider AuthProvider

+ CommandLinePlugin CommandLinePlugin

+ Executor ProviderExecutor

+ ExecutorInputFormats []string

+ ExecutorModelScope ExecutorModelScope

+ ExecutorOutputFormats []string

+ FrontendAuthProvider FrontendAuthProvider

+ FrontendAuthProviderExclusive bool

+ ManagementAPI ManagementAPI

+ ModelProvider ModelProvider

+ ModelRegistrar ModelRegistrar

+ RequestInterceptor RequestInterceptor

+ RequestNormalizer RequestNormalizer

+ RequestTranslator RequestTranslator

+ ResponseAfterTranslator ResponseNormalizer

+ ResponseBeforeTranslator ResponseNormalizer

+ ResponseInterceptor ResponseInterceptor

+ ResponseTranslator ResponseTranslator

+ Scheduler Scheduler

+ StreamChunkInterceptor StreamChunkInterceptor

+ ThinkingApplier ThinkingApplier

+ UsagePlugin UsagePlugin

+ type CommandLineExecutionRequest struct

+ Args []string

+ ConfigPath string

+ Flags map[string]CommandLineFlagValue

+ Host HostConfigSummary

+ Plugin Metadata

+ Program string

+ TriggeredFlags map[string]CommandLineFlagValue

+ type CommandLineExecutionResponse struct

+ Auths []AuthData

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

+ type CommandLineFlag struct

+ DefaultValue string

+ Name string

+ Type string

+ Usage string

+ type CommandLineFlagValue struct

+ Name string

+ Set bool

+ Type string

+ Value string

+ type CommandLinePlugin interface

+ ExecuteCommandLine func(context.Context, CommandLineExecutionRequest) (CommandLineExecutionResponse, error)

+ RegisterCommandLine func(context.Context, CommandLineRegistrationRequest) (CommandLineRegistrationResponse, error)

+ type CommandLineRegistrationRequest struct

+ Plugin Metadata

+ type CommandLineRegistrationResponse struct

+ Flags []CommandLineFlag

+ type ConfigField struct

+ Description string

+ EnumValues []string

+ Name string

+ Type ConfigFieldType

+ type ConfigFieldType string

+ const ConfigFieldTypeArray

+ const ConfigFieldTypeBoolean

+ const ConfigFieldTypeEnum

+ const ConfigFieldTypeInteger

+ const ConfigFieldTypeNumber

+ const ConfigFieldTypeObject

+ const ConfigFieldTypeString

+ type ExecutorHTTPRequest struct

+ Attributes map[string]string

+ AuthID string

+ AuthProvider string

+ Body []byte

+ HTTPClient HostHTTPClient

+ Headers http.Header

+ Metadata map[string]any

+ Method string

+ StorageJSON []byte

+ URL string

+ type ExecutorHTTPResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type ExecutorModelScope string

+ const ExecutorModelScopeBoth

+ const ExecutorModelScopeOAuth

+ const ExecutorModelScopeStatic

+ type ExecutorRequest struct

+ Alt string

+ AuthAttributes map[string]string

+ AuthID string

+ AuthMetadata map[string]any

+ AuthProvider string

+ Format string

+ HTTPClient HostHTTPClient

+ Headers http.Header

+ Metadata map[string]any

+ Model string

+ OriginalRequest []byte

+ Payload []byte

+ Query url.Values

+ SourceFormat string

+ StorageJSON []byte

+ Stream bool

+ type ExecutorResponse struct

+ Headers http.Header

+ Metadata map[string]any

+ Payload []byte

+ type ExecutorStreamChunk struct

+ Err error

+ Payload []byte

+ type ExecutorStreamResponse struct

+ Chunks <-chan ExecutorStreamChunk

+ Headers http.Header

+ type FrontendAuthProvider interface

+ Authenticate func(context.Context, FrontendAuthRequest) (FrontendAuthResponse, error)

+ Identifier func() string

+ type FrontendAuthRequest struct

+ Body []byte

+ Headers http.Header

+ Method string

+ Path string

+ Query url.Values

+ type FrontendAuthResponse struct

+ Authenticated bool

+ Metadata map[string]string

+ Principal string

+ type HTTPRequest struct

+ Body []byte

+ Headers http.Header

+ Method string

+ URL string

+ type HTTPResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type HTTPStreamChunk struct

+ Err error

+ Payload []byte

+ type HTTPStreamResponse struct

+ Chunks <-chan HTTPStreamChunk

+ Headers http.Header

+ StatusCode int

+ type HostAuthFileEntry struct

+ Account string

+ AccountType string

+ AuthIndex string

+ CreatedAt time.Time

+ Disabled bool

+ Email string

+ Failed int64

+ ID string

+ Label string

+ LastRefresh time.Time

+ ModTime time.Time

+ Name string

+ NextRetryAfter time.Time

+ Note string

+ Path string

+ Priority int

+ ProjectID string

+ Provider string

+ RecentRequests []HostRecentRequestEntry

+ RuntimeOnly bool

+ Size int64

+ Source string

+ Status string

+ StatusMessage string

+ Success int64

+ Type string

+ Unavailable bool

+ UpdatedAt time.Time

+ Websockets bool

+ type HostAuthGetRequest struct

+ AuthIndex string

+ type HostAuthGetResponse struct

+ AuthIndex string

+ JSON json.RawMessage

+ Name string

+ Path string

+ type HostAuthGetRuntimeResponse struct

+ Auth HostAuthFileEntry

+ type HostAuthSaveRequest struct

+ JSON json.RawMessage

+ Name string

+ type HostAuthSaveResponse struct

+ Name string

+ Path string

+ type HostConfigSummary struct

+ AuthDir string

+ ExcludedModels map[string][]string

+ ForceModelPrefix bool

+ OAuthModelAlias map[string][]ModelAlias

+ ProxyURL string

+ type HostHTTPClient interface

+ Do func(context.Context, HTTPRequest) (HTTPResponse, error)

+ DoStream func(context.Context, HTTPRequest) (HTTPStreamResponse, error)

+ type HostModelExecutionRequest struct

+ Alt string

+ Body []byte

+ EntryProtocol string

+ ExitProtocol string

+ Headers http.Header

+ Model string

+ Query url.Values

+ Stream bool

+ type HostModelExecutionResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type HostModelStreamCloseRequest struct

+ StreamID string

+ type HostModelStreamReadRequest struct

+ StreamID string

+ type HostModelStreamReadResponse struct

+ Done bool

+ Error string

+ Payload []byte

+ type HostModelStreamResponse struct

+ Headers http.Header

+ StatusCode int

+ StreamID string

+ type HostRecentRequestEntry struct

+ Failed int64

+ Success int64

+ Time string

+ type ManagementAPI interface

+ RegisterManagement func(context.Context, ManagementRegistrationRequest) (ManagementRegistrationResponse, error)

+ type ManagementHandler interface

+ HandleManagement func(context.Context, ManagementRequest) (ManagementResponse, error)

+ type ManagementRegistrationRequest struct

+ BasePath string

+ Plugin Metadata

+ ResourceBasePath string

+ type ManagementRegistrationResponse struct

+ Resources []ResourceRoute

+ Routes []ManagementRoute

+ type ManagementRequest struct

+ Body []byte

+ Headers http.Header

+ Method string

+ Path string

+ Query url.Values

+ type ManagementResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type ManagementRoute struct

+ Description string

+ Handler ManagementHandler

+ Menu string

+ Method string

+ Path string

+ type Metadata struct

+ Author string

+ ConfigFields []ConfigField

+ GitHubRepository string

+ Logo string

+ Name string

+ Version string

+ type ModelAlias struct

+ Alias string

+ Name string

+ type ModelInfo struct

+ ContextLength int64

+ Created int64

+ Description string

+ DisplayName string

+ ID string

+ InputTokenLimit int64

+ MaxCompletionTokens int64

+ Name string

+ Object string

+ OutputTokenLimit int64

+ OwnedBy string

+ SupportedGenerationMethods []string

+ SupportedInputModalities []string

+ SupportedOutputModalities []string

+ SupportedParameters []string

+ Thinking *ThinkingSupport

+ Type string

+ UserDefined bool

+ Version string

+ type ModelProvider interface

+ ModelsForAuth func(context.Context, AuthModelRequest) (ModelResponse, error)

+ StaticModels func(context.Context, StaticModelRequest) (ModelResponse, error)

+ type ModelRegistrar interface

+ RegisterModels func(context.Context, ModelRegistrationRequest) (ModelRegistrationResponse, error)

+ type ModelRegistrationRequest struct

+ Plugin Metadata

+ type ModelRegistrationResponse struct

+ Models []ModelInfo

+ Provider string

+ type ModelResponse struct

+ AuthUpdate AuthData

+ Models []ModelInfo

+ Provider string

+ type PayloadResponse struct

+ Body []byte

+ type Plugin struct

+ Capabilities Capabilities

+ Metadata Metadata

+ type ProviderExecutor interface

+ CountTokens func(context.Context, ExecutorRequest) (ExecutorResponse, error)

+ Execute func(context.Context, ExecutorRequest) (ExecutorResponse, error)

+ ExecuteStream func(context.Context, ExecutorRequest) (ExecutorStreamResponse, error)

+ HttpRequest func(context.Context, ExecutorHTTPRequest) (ExecutorHTTPResponse, error)

+ Identifier func() string

+ type RequestInterceptRequest struct

+ Body []byte

+ Headers http.Header

+ Metadata map[string]any

+ Model string

+ RequestedModel string

+ SourceFormat string

+ Stream bool

+ ToFormat string

+ type RequestInterceptResponse struct

+ Body []byte

+ ClearHeaders []string

+ Headers http.Header

+ type RequestInterceptor interface

+ InterceptRequestAfterAuth func(context.Context, RequestInterceptRequest) (RequestInterceptResponse, error)

+ InterceptRequestBeforeAuth func(context.Context, RequestInterceptRequest) (RequestInterceptResponse, error)

+ type RequestNormalizer interface

+ NormalizeRequest func(context.Context, RequestTransformRequest) (PayloadResponse, error)

+ type RequestTransformRequest struct

+ Body []byte

+ FromFormat string

+ Model string

+ Stream bool

+ ToFormat string

+ type RequestTranslator interface

+ TranslateRequest func(context.Context, RequestTransformRequest) (PayloadResponse, error)

+ type ResourceRoute struct

+ Description string

+ Handler ManagementHandler

+ Menu string

+ Path string

+ type ResponseInterceptRequest struct

+ Body []byte

+ Metadata map[string]any

+ Model string

+ OriginalRequest []byte

+ RequestBody []byte

+ RequestHeaders http.Header

+ RequestedModel string

+ ResponseHeaders http.Header

+ SourceFormat string

+ StatusCode int

+ Stream bool

+ type ResponseInterceptResponse struct

+ Body []byte

+ ClearHeaders []string

+ Headers http.Header

+ type ResponseInterceptor interface

+ InterceptResponse func(context.Context, ResponseInterceptRequest) (ResponseInterceptResponse, error)

+ type ResponseNormalizer interface

+ NormalizeResponse func(context.Context, ResponseTransformRequest) (PayloadResponse, error)

+ type ResponseTransformRequest struct

+ Body []byte

+ FromFormat string

+ Model string

+ OriginalRequest []byte

+ Stream bool

+ ToFormat string

+ TranslatedRequest []byte

+ type ResponseTranslator interface

+ TranslateResponse func(context.Context, ResponseTransformRequest) (PayloadResponse, error)

+ type Scheduler interface

+ Pick func(context.Context, SchedulerPickRequest) (SchedulerPickResponse, error)

+ type SchedulerAuthCandidate struct

+ Attributes map[string]string

+ ID string

+ Metadata map[string]any

+ Priority int

+ Provider string

+ Status string

+ type SchedulerOptions struct

+ Headers map[string][]string

+ Metadata map[string]any

+ type SchedulerPickRequest struct

+ Candidates []SchedulerAuthCandidate

+ Model string

+ Options SchedulerOptions

+ Plugin Metadata

+ Provider string

+ Providers []string

+ Stream bool

+ type SchedulerPickResponse struct

+ AuthID string

+ DelegateBuiltin string

+ Handled bool

+ type StaticModelRequest struct

+ Host HostConfigSummary

+ Plugin Metadata

+ type StreamChunkInterceptRequest struct

+ Body []byte

+ ChunkIndex int

+ HistoryChunks [][]byte

+ Metadata map[string]any

+ Model string

+ OriginalRequest []byte

+ RequestBody []byte

+ RequestHeaders http.Header

+ RequestedModel string

+ ResponseHeaders http.Header

+ SourceFormat string

+ type StreamChunkInterceptResponse struct

+ Body []byte

+ ClearHeaders []string

+ DropChunk bool

+ Headers http.Header

+ type StreamChunkInterceptor interface

+ InterceptStreamChunk func(context.Context, StreamChunkInterceptRequest) (StreamChunkInterceptResponse, error)

+ type ThinkingApplier interface

+ ApplyThinking func(context.Context, ThinkingApplyRequest) (PayloadResponse, error)

+ Identifier func() string

+ type ThinkingApplyRequest struct

+ Body []byte

+ Config ThinkingConfig

+ Model ModelInfo

+ Provider string

+ type ThinkingConfig struct

+ Budget int

+ Level string

+ Mode string

+ type ThinkingSupport struct

+ DynamicAllowed bool

+ Levels []string

+ Max int

+ Min int

+ ZeroAllowed bool

+ type UsageDetail struct

+ CacheCreationTokens int64

+ CacheReadTokens int64

+ CachedTokens int64

+ InputTokens int64

+ OutputTokens int64

+ ReasoningTokens int64

+ TotalTokens int64

+ type UsageFailure struct

+ Body string

+ StatusCode int

+ type UsagePlugin interface

+ HandleUsage func(context.Context, UsageRecord)

+ type UsageRecord struct

+ APIKey string

+ Alias string

+ AuthID string

+ AuthIndex string

+ AuthType string

+ Detail UsageDetail

+ ExecutorType string

+ Failed bool

+ Failure UsageFailure

+ Latency time.Duration

+ Model string

+ Provider string

+ ReasoningEffort string

+ RequestedAt time.Time

+ ResponseHeaders http.Header

+ ServiceTier string

+ Source string

+ TTFT time.Duration

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