operations

type AcceptHeaderEnum string

type AllowedDataRegion string

type Arena string

type BenchmarkType string

type BulkAddWorkspaceMembersRequest struct {
	// The workspace ID (UUID) or slug
	ID                             string                                    `pathParam:"style=simple,explode=false,name=id"`
	BulkAddWorkspaceMembersRequest components.BulkAddWorkspaceMembersRequest `request:"mediaType=application/json"`
}

type BulkAssignKeysToGuardrailRequest struct {
	// The unique identifier of the guardrail
	ID                    string                           `pathParam:"style=simple,explode=false,name=id"`
	BulkAssignKeysRequest components.BulkAssignKeysRequest `request:"mediaType=application/json"`
}

type BulkAssignMembersToGuardrailRequest struct {
	// The unique identifier of the guardrail
	ID                       string                              `pathParam:"style=simple,explode=false,name=id"`
	BulkAssignMembersRequest components.BulkAssignMembersRequest `request:"mediaType=application/json"`
}

type BulkRemoveWorkspaceMembersRequest struct {
	// The workspace ID (UUID) or slug
	ID                                string                                       `pathParam:"style=simple,explode=false,name=id"`
	BulkRemoveWorkspaceMembersRequest components.BulkRemoveWorkspaceMembersRequest `request:"mediaType=application/json"`
}

type BulkUnassignKeysFromGuardrailRequest struct {
	// The unique identifier of the guardrail
	ID                      string                             `pathParam:"style=simple,explode=false,name=id"`
	BulkUnassignKeysRequest components.BulkUnassignKeysRequest `request:"mediaType=application/json"`
}

type BulkUnassignMembersFromGuardrailRequest struct {
	// The unique identifier of the guardrail
	ID                         string                                `pathParam:"style=simple,explode=false,name=id"`
	BulkUnassignMembersRequest components.BulkUnassignMembersRequest `request:"mediaType=application/json"`
}

type ClassifierDimensions struct {
	// UUID of the classifier whose tags to group by.
	ClassifierID   string   `json:"classifier_id"`
	DimensionNames []string `json:"dimension_names,omitzero"`
	// When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations.
	IncludeNulls *bool `json:"include_nulls,omitzero"`
}

type ClassifierFilters struct {
	// UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified.
	ClassifierID string                    `json:"classifier_id"`
	Filters      []ClassifierFiltersFilter `json:"filters"`
}

type ClassifierFiltersFilter struct {
	// Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type").
	Field string `json:"field"`
	// Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings.
	Operator string `json:"operator"`
	// Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in.
	Value ClassifierFiltersValue `json:"value"`
}

type ClassifierFiltersValue struct {
	Str                           *string                  `queryParam:"inline" union:"member"`
	Number                        *float64                 `queryParam:"inline" union:"member"`
	ArrayOfValueClassifierFilters []ValueClassifierFilters `queryParam:"inline" union:"member"`

	Type ClassifierFiltersValueType
}

type ClassifierFiltersValueType string

type Content struct {
	ContentText           *ContentText                      `queryParam:"inline" union:"member"`
	ContentImageURL       *ContentImageURL                  `queryParam:"inline" union:"member"`
	ContentPartInputAudio *components.ContentPartInputAudio `queryParam:"inline" union:"member"`
	ContentPartInputVideo *components.ContentPartInputVideo `queryParam:"inline" union:"member"`
	ContentPartInputFile  *components.ContentPartInputFile  `queryParam:"inline" union:"member"`

	Type ContentType
}

type ContentImageURL struct {
	ImageURL ImageURL     `json:"image_url"`
	Type     TypeImageURL `json:"type"`
}

type ContentText struct {
	Text string   `json:"text"`
	Type TypeText `json:"type"`
}

type ContentType string

type ContextBucket string

type CopyVaultSecretsToInternRequest struct {
	// UUID of an intern in the workspace selected by the API key.
	InternID               string                            `pathParam:"style=simple,explode=false,name=internId"`
	VaultSecretCopyRequest components.VaultSecretCopyRequest `request:"mediaType=application/json"`
}

type CreateAudioTranscriptionsMultipartFile struct {
	FileName string `multipartForm:"name=fileName"`
	// This field accepts []byte data or io.Reader implementations, such as *os.File.
	Content any `multipartForm:"content"`
}

type CreateAudioTranscriptionsMultipartRequest struct {
	// The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio.
	File CreateAudioTranscriptionsMultipartFile `multipartForm:"file,name=file"`
	// The language of the input audio (ISO-639-1).
	Language *string `multipartForm:"name=language"`
	// The model to use for transcription.
	Model string `multipartForm:"name=model"`
	// The response format. "json" (default) returns { text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only).
	ResponseFormat *ResponseFormat `multipartForm:"name=response_format"`
	// A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence.
	SessionID *string `multipartForm:"name=session_id"`
	// The sampling temperature.
	Temperature *float64 `multipartForm:"name=temperature"`
	// Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array.
	TimestampGranularities []TimestampGranularities `multipartForm:"name=timestamp_granularities[]"`
	// JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object.
	Trace *string `multipartForm:"name=trace"`
	// A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider.
	User *string `multipartForm:"name=user"`
}

type CreateAuthKeysCodeCodeChallengeMethod string

type CreateAuthKeysCodeData struct {
	// The application ID associated with this auth code
	AppID int64 `json:"app_id"`
	// ISO 8601 timestamp of when the auth code was created
	CreatedAt string `json:"created_at"`
	// The authorization code ID to use in the exchange request
	ID string `json:"id"`
}

type CreateAuthKeysCodeRequest struct {
	// The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools.
	CallbackURL string `json:"callback_url"`
	// PKCE code challenge for enhanced security
	CodeChallenge *string `json:"code_challenge,omitzero"`
	// The method used to generate the code challenge
	CodeChallengeMethod *CreateAuthKeysCodeCodeChallengeMethod `json:"code_challenge_method,omitzero"`
	// Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected.
	ExpiresAt optionalnullable.OptionalNullable[time.Time] `json:"expires_at,omitzero"`
	// Optional custom label for the API key. Defaults to the app name if not provided.
	KeyLabel *string `json:"key_label,omitzero"`
	// Credit limit for the API key to be created
	Limit *float64 `json:"limit,omitzero"`
	// Optional credit limit reset interval. When set, the credit limit resets on this interval.
	UsageLimitType *UsageLimitType `json:"usage_limit_type,omitzero"`
	// Optional workspace ID to associate the API key with
	WorkspaceID *string `json:"workspace_id,omitzero"`
}

type CreateAuthKeysCodeResponse struct {
	// Auth code data
	Data CreateAuthKeysCodeData `json:"data"`
}

type CreateEmbeddingsData struct {
	// Embedding vector as an array of floats or a base64 string
	Embedding Embedding `json:"embedding"`
	// Index of the embedding in the input list
	Index  *int64          `json:"index,omitzero"`
	Object ObjectEmbedding `json:"object"`
}

type CreateEmbeddingsRequest struct {
	// The number of dimensions for the output embeddings
	Dimensions *int64 `json:"dimensions,omitzero"`
	// The format of the output embeddings
	EncodingFormat *EncodingFormat `json:"encoding_format,omitzero"`
	// Text, token, or multimodal input(s) to embed
	Input InputUnion `json:"input"`
	// The type of input (e.g. search_query, search_document)
	InputType *string `json:"input_type,omitzero"`
	// The model to use for embeddings
	Model    string                                                            `json:"model"`
	Provider optionalnullable.OptionalNullable[components.ProviderPreferences] `json:"provider,omitzero"`
	// A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters.
	SessionID *string `json:"session_id,omitzero"`
	// Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
	Trace *components.TraceConfig `json:"trace,omitzero"`
	// A unique identifier for the end-user
	User *string `json:"user,omitzero"`
}

type CreateEmbeddingsResponse struct {
	CreateEmbeddingsResponseBody *CreateEmbeddingsResponseBody `queryParam:"inline" union:"member"`
	Str                          *string                       `queryParam:"inline" union:"member"`

	Type CreateEmbeddingsResponseType
}

type CreateEmbeddingsResponseBody struct {
	// List of embedding objects
	Data []CreateEmbeddingsData `json:"data"`
	// Unique identifier for the embeddings response
	ID *string `json:"id,omitzero"`
	// The model used for embeddings
	Model  string `json:"model"`
	Object Object `json:"object"`
	// Token usage statistics
	Usage *CreateEmbeddingsUsage `json:"usage,omitzero"`
}

type CreateEmbeddingsResponseType string

type CreateEmbeddingsUsage struct {
	// Cost of the request in credits
	Cost *float64 `json:"cost,omitzero"`
	// Breakdown of upstream inference costs
	CostDetails optionalnullable.OptionalNullable[components.CostDetails] `json:"cost_details,omitzero"`
	// Whether a request was made using a Bring Your Own Key configuration
	IsBYOK *bool `json:"is_byok,omitzero"`
	// Number of tokens in the input
	PromptTokens int64 `json:"prompt_tokens"`
	// Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included.
	PromptTokensDetails *PromptTokensDetails `json:"prompt_tokens_details,omitzero"`
	// Total number of tokens used
	TotalTokens int64 `json:"total_tokens"`
}

type CreateImagesResponse struct {
	ImageGenerationResponse *components.ImageGenerationResponse                    `queryParam:"inline" union:"member"`
	EventStream             *stream.EventStream[components.ImageStreamingResponse] `queryParam:"inline" union:"member"`

	Type CreateImagesResponseType
}

type CreateImagesResponseType string

type CreateInternRequest struct {
	// Key that makes retries resume the same create operation. Without one, the server derives a stable key from the request body.
	IdempotencyKey      *string                        `header:"style=simple,explode=false,name=Idempotency-Key"`
	CreateInternRequest components.CreateInternRequest `request:"mediaType=application/json"`
}

type CreateKeysData struct {
	// Total external BYOK usage (in USD) for the API key
	BYOKUsage float64 `json:"byok_usage"`
	// External BYOK usage (in USD) for the current UTC day
	BYOKUsageDaily float64 `json:"byok_usage_daily"`
	// External BYOK usage (in USD) for current UTC month
	BYOKUsageMonthly float64 `json:"byok_usage_monthly"`
	// External BYOK usage (in USD) for the current UTC week (Monday-Sunday)
	BYOKUsageWeekly float64 `json:"byok_usage_weekly"`
	// ISO 8601 timestamp of when the API key was created
	CreatedAt string `json:"created_at"`
	// The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID.
	CreatorUserID *string `json:"creator_user_id"`
	// Whether the API key is disabled
	Disabled bool `json:"disabled"`
	// ISO 8601 UTC timestamp when the API key expires, or null if no expiration
	ExpiresAt optionalnullable.OptionalNullable[time.Time] `json:"expires_at,omitzero"`
	// Partner's end-user identifier used for attribution.
	ExternalUser *string `json:"external_user"`
	// Unique hash identifier for the API key
	Hash string `json:"hash"`
	// Whether to include external BYOK usage in the credit limit
	IncludeBYOKInLimit bool `json:"include_byok_in_limit"`
	// Human-readable label for the API key
	Label string `json:"label"`
	// Spending limit for the API key in USD
	Limit *float64 `json:"limit"`
	// Remaining spending limit in USD
	LimitRemaining *float64 `json:"limit_remaining"`
	// Type of limit reset for the API key
	LimitReset *string `json:"limit_reset"`
	// Name of the API key
	Name string `json:"name"`
	// ISO 8601 timestamp of when the API key was last updated
	UpdatedAt *string `json:"updated_at"`
	// Total OpenRouter credit usage (in USD) for the API key
	Usage float64 `json:"usage"`
	// OpenRouter credit usage (in USD) for the current UTC day
	UsageDaily float64 `json:"usage_daily"`
	// OpenRouter credit usage (in USD) for the current UTC month
	UsageMonthly float64 `json:"usage_monthly"`
	// OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)
	UsageWeekly float64 `json:"usage_weekly"`
	// The workspace ID this API key belongs to.
	WorkspaceID string `json:"workspace_id"`
}

type CreateKeysLimitReset string

type CreateKeysRequest struct {
	// Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.
	CreatorUserID optionalnullable.OptionalNullable[string] `json:"creator_user_id,omitzero"`
	// Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected.
	ExpiresAt optionalnullable.OptionalNullable[time.Time] `json:"expires_at,omitzero"`
	// Optional partner-defined identity associated with the created API key.
	External *External `json:"external,omitzero"`
	// Whether to include BYOK usage in the limit
	IncludeBYOKInLimit *bool `json:"include_byok_in_limit,omitzero"`
	// Optional spending limit for the API key in USD
	Limit optionalnullable.OptionalNullable[float64] `json:"limit,omitzero"`
	// Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
	LimitReset optionalnullable.OptionalNullable[CreateKeysLimitReset] `json:"limit_reset,omitzero"`
	// Name for the new API key
	Name string `json:"name"`
	// The workspace to create the API key in. Defaults to the default workspace if not provided.
	WorkspaceID *string `json:"workspace_id,omitzero"`
}

type CreateKeysResponse struct {
	// The created API key information
	Data CreateKeysData `json:"data"`
	// The actual API key string (only shown once)
	Key string `json:"key"`
}

type CreatePresetsChatCompletionsRequest struct {
	// URL-safe slug identifying the preset. Created if it does not exist.
	Slug        string                 `pathParam:"style=simple,explode=false,name=slug"`
	ChatRequest components.ChatRequest `request:"mediaType=application/json"`
}

type CreatePresetsMessagesRequest struct {
	// URL-safe slug identifying the preset. Created if it does not exist.
	Slug            string                     `pathParam:"style=simple,explode=false,name=slug"`
	MessagesRequest components.MessagesRequest `request:"mediaType=application/json"`
}

type CreatePresetsResponsesRequest struct {
	// URL-safe slug identifying the preset. Created if it does not exist.
	Slug             string                      `pathParam:"style=simple,explode=false,name=slug"`
	ResponsesRequest components.ResponsesRequest `request:"mediaType=application/json"`
}

type CreateRerankRequest struct {
	// The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models.
	Documents []Document `json:"documents"`
	// The rerank model to use
	Model    string                                                            `json:"model"`
	Provider optionalnullable.OptionalNullable[components.ProviderPreferences] `json:"provider,omitzero"`
	// The search query to rerank documents against
	Query string `json:"query"`
	// A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters.
	SessionID *string `json:"session_id,omitzero"`
	// Number of most relevant documents to return
	TopN *int64 `json:"top_n,omitzero"`
	// Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
	Trace *components.TraceConfig `json:"trace,omitzero"`
	// A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider.
	User *string `json:"user,omitzero"`
}

type CreateRerankResponse struct {
	CreateRerankResponseBody *CreateRerankResponseBody `queryParam:"inline" union:"member"`
	Str                      *string                   `queryParam:"inline" union:"member"`

	Type CreateRerankResponseType
}

type CreateRerankResponseBody struct {
	// Unique identifier for the rerank response (ORID format)
	ID *string `json:"id,omitzero"`
	// The model used for reranking
	Model string `json:"model"`
	// The provider that served the rerank request
	Provider *string `json:"provider,omitzero"`
	// List of rerank results sorted by relevance
	Results []Result `json:"results"`
	// Usage statistics
	Usage *CreateRerankUsage `json:"usage,omitzero"`
}

type CreateRerankResponseType string

type CreateRerankUsage struct {
	// Cost of the request in credits
	Cost *float64 `json:"cost,omitzero"`
	// Number of search units consumed (Cohere billing)
	SearchUnits *int64 `json:"search_units,omitzero"`
	// Total number of tokens used
	TotalTokens *int64 `json:"total_tokens,omitzero"`
}

type CreateResponsesRequest struct {
	// Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility.
	XOpenRouterMetadata *components.MetadataLevel   `header:"style=simple,explode=false,name=X-OpenRouter-Metadata"`
	ResponsesRequest    components.ResponsesRequest `request:"mediaType=application/json"`
}

type CreateResponsesResponse struct {
	OpenResponsesResult *components.OpenResponsesResult                            `queryParam:"inline" union:"member"`
	EventStream         *stream.EventStream[components.ResponsesStreamingResponse] `queryParam:"inline" union:"member"`

	Type CreateResponsesResponseType
}

type CreateResponsesResponseType string

type CreateScimSyncJobResponse struct {
	Headers map[string][]string
	Result  components.CreateScimSyncJobResponse
}

type Datacenter string

type DeleteBYOKKeyRequest struct {
	// The BYOK credential ID (UUID).
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

type DeleteFileRequest struct {
	FileID string `pathParam:"style=simple,explode=false,name=file_id"`
	// Workspace to scope the request to. Defaults to the caller’s default workspace.
	WorkspaceID *string `queryParam:"style=form,explode=true,name=workspace_id"`
	// Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage.
	Provider *components.FileProvider `queryParam:"style=form,explode=true,name=provider"`
}

type DeleteGuardrailRequest struct {
	// The unique identifier of the guardrail to delete
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

type DeleteInternRequest struct {
	// ID of an intern visible to the authenticated API key.
	InternID string `pathParam:"style=simple,explode=false,name=internId"`
}

type DeleteInternVaultSecretRequest struct {
	// UUID of an intern in the workspace selected by the API key.
	InternID string `pathParam:"style=simple,explode=false,name=internId"`
	// Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters.
	Name string `pathParam:"style=simple,explode=false,name=name"`
}

type DeleteKeysRequest struct {
	// The hash identifier of the API key to delete
	Hash string `pathParam:"style=simple,explode=false,name=hash"`
}

type DeleteKeysResponse struct {
	// contains filtered or unexported fields
}

type DeleteObservabilityDestinationRequest struct {
	// The destination ID (UUID).
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

type DeleteScimGroupMappingRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required.
	KeepMembers KeepMembers `queryParam:"style=form,explode=true,name=keep_members"`
}

type DeleteVaultSecretRequest struct {
	// Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters.
	Name string `pathParam:"style=simple,explode=false,name=name"`
}

type DeleteWorkspaceBudgetRequest struct {
	// The workspace ID (UUID) or slug
	WorkspaceRef string `pathParam:"style=simple,explode=false,name=workspace_ref"`
	// Budget reset interval. Use "lifetime" for a one-time budget that never resets.
	Interval components.WorkspaceBudgetInterval `pathParam:"style=simple,explode=false,name=interval"`
}

type DeleteWorkspaceRequest struct {
	// The workspace ID (UUID) or slug
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces.
	ConfirmDefaultWorkspaceDeletion *bool `queryParam:"style=form,explode=true,name=confirm_default_workspace_deletion"`
}

type Dimension struct {
	// Human-readable label
	DisplayLabel string `json:"display_label"`
	// Dimension identifier used in query requests
	Name string `json:"name"`
}

type Direction string

type DisplayFormat string

type Distillable string

type Document struct {
	Str             *string          `queryParam:"inline" union:"member"`
	DocumentRequest *DocumentRequest `queryParam:"inline" union:"member"`

	Type DocumentType
}

type DocumentRequest struct {
	// An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...).
	Image *string `json:"image,omitzero"`
	// The document text
	Text *string `json:"text,omitzero"`
}

type DocumentResponse struct {
	// The image (URL or data URI) from the original document
	Image *string `json:"image,omitzero"`
	// The document text
	Text *string `json:"text,omitzero"`
}

type DocumentType string

type DownloadContainerFileContentRequest struct {
	// The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r<nonce>`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent.
	ContainerID string `pathParam:"style=simple,explode=false,name=container_id"`
	// Container file id (`cfile_` + base64url of the file path).
	FileID string `pathParam:"style=simple,explode=false,name=file_id"`
}

type DownloadFileContentRequest struct {
	FileID string `pathParam:"style=simple,explode=false,name=file_id"`
	// Workspace to scope the request to. Defaults to the caller’s default workspace.
	WorkspaceID *string `queryParam:"style=form,explode=true,name=workspace_id"`
	// Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage.
	Provider *components.FileProvider `queryParam:"style=form,explode=true,name=provider"`
}

type Embedding struct {
	ArrayOfNumber []float64 `queryParam:"inline" union:"member"`
	Str           *string   `queryParam:"inline" union:"member"`

	Type EmbeddingType
}

type EmbeddingType string

type EncodingFormat string

type ExchangeAuthCodeForAPIKeyCodeChallengeMethod string

type ExchangeAuthCodeForAPIKeyRequest struct {
	// The authorization code received from the OAuth redirect
	Code string `json:"code"`
	// The method used to generate the code challenge
	CodeChallengeMethod optionalnullable.OptionalNullable[ExchangeAuthCodeForAPIKeyCodeChallengeMethod] `json:"code_challenge_method,omitzero"`
	// The code verifier if code_challenge was used in the authorization request
	CodeVerifier *string `json:"code_verifier,omitzero"`
}

type ExchangeAuthCodeForAPIKeyResponse struct {
	// The API key to use for OpenRouter requests
	Key string `json:"key"`
	// User ID associated with the API key
	UserID *string `json:"user_id"`
}

type External struct {
	// Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned.
	APIKey *string `json:"api_key,omitzero"`
	// Partner's end-user identifier for attribution.
	User string `json:"user"`
}

type Filter struct {
	// Dimension to filter on. Use the /meta endpoint for available dimensions.
	Field string `json:"field"`
	// Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket.
	IncludeUnset *bool `json:"include_unset,omitzero"`
	// Filter operator
	Operator string `json:"operator"`
	// Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned.
	Value Value1 `json:"value"`
}

type GetAnalyticsMetaData struct {
	Dimensions    []Dimension   `json:"dimensions"`
	Granularities []Granularity `json:"granularities"`
	Metrics       []Metric      `json:"metrics"`
	Operators     []Operator    `json:"operators"`
}

type GetAnalyticsMetaResponse struct {
	Data GetAnalyticsMetaData `json:"data"`
}

type GetAppRankingsCategory string

type GetAppRankingsRequest struct {
	// Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group.
	Category *GetAppRankingsCategory `queryParam:"style=form,explode=true,name=category"`
	// Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent.
	Subcategory *Subcategory `queryParam:"style=form,explode=true,name=subcategory"`
	// `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results.
	Sort *GetAppRankingsSort `default:"popular" queryParam:"style=form,explode=true,name=sort"`
	// Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`.
	StartDate *string `queryParam:"style=form,explode=true,name=start_date"`
	// End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400.
	EndDate *string `queryParam:"style=form,explode=true,name=end_date"`
	// Maximum number of apps to return (1-100). Defaults to 50.
	Limit *int64 `default:"50" queryParam:"style=form,explode=true,name=limit"`
	// Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`.
	Offset optionalnullable.OptionalNullable[int64] `default:"0" queryParam:"style=form,explode=true,name=offset"`
}

type GetAppRankingsResponse struct {
	Result components.AppRankingsResponse

	Next func() (*GetAppRankingsResponse, error)
}

type GetAppRankingsSort string

type GetBYOKKeyRequest struct {
	// The BYOK credential ID (UUID).
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

type GetBenchmarksRequest struct {
	// Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources.
	Source *Source `queryParam:"style=form,explode=true,name=source"`
	// Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only.
	TaskType *TaskType `queryParam:"style=form,explode=true,name=task_type"`
	// Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are.
	BenchmarkType *BenchmarkType `queryParam:"style=form,explode=true,name=benchmark_type"`
	// Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract.
	IncludeRunConfig *bool `default:"false" queryParam:"style=form,explode=true,name=include_run_config"`
	// OpenRouter search benchmarks only: filter by the search engine used.
	SearchEngine *string `queryParam:"style=form,explode=true,name=search_engine"`
	// OpenRouter search benchmarks only: filter by the request surface the lane ran on.
	SearchSurface *SearchSurface `queryParam:"style=form,explode=true,name=search_surface"`
	// Design Arena only: arena to query. Defaults to `models` when source is `design-arena`.
	Arena *Arena `queryParam:"style=form,explode=true,name=arena"`
	// Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories.
	Category *string `queryParam:"style=form,explode=true,name=category"`
	// Maximum number of items to return. When omitted, all matching results are returned.
	MaxResults *int64 `queryParam:"style=form,explode=true,name=max_results"`
}