import * as z from "zod/v4"; import { ClosedEnum, OpenEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import * as models from "../index.js"; export type GetModelsGlobals = { /** * The app identifier should be your app's URL and is used as the primary identifier for rankings. * * @remarks * This is used to track API usage per application. */ httpReferer?: string | undefined; /** * The app display name allows you to customize how your app appears in OpenRouter's dashboard. * * @remarks */ appTitle?: string | undefined; /** * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings. * * @remarks */ appCategories?: string | undefined; }; /** * Filter models by use case category */ export declare const GetModelsCategory: { readonly Programming: "programming"; readonly Roleplay: "roleplay"; readonly Marketing: "marketing"; readonly MarketingSeo: "marketing/seo"; readonly Technology: "technology"; readonly Science: "science"; readonly Translation: "translation"; readonly Legal: "legal"; readonly Finance: "finance"; readonly Health: "health"; readonly Trivia: "trivia"; readonly Academia: "academia"; }; /** * Filter models by use case category */ export type GetModelsCategory = OpenEnum; /** * Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), -high-to-low for each Artificial Analysis index (the coding and agentic sorts are deprecated: Artificial Analysis has retired those indexes, so they order by canonical slug and variant alone), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. The decision sort ranks decision models, so pass output_modalities=decisions or all with it. When omitted, the existing default ordering is preserved. */ export declare const GetModelsSort: { readonly MostPopular: "most-popular"; readonly Newest: "newest"; readonly TopWeekly: "top-weekly"; readonly PricingLowToHigh: "pricing-low-to-high"; readonly PricingHighToLow: "pricing-high-to-low"; readonly ContextHighToLow: "context-high-to-low"; readonly ThroughputHighToLow: "throughput-high-to-low"; readonly LatencyLowToHigh: "latency-low-to-high"; readonly IntelligenceHighToLow: "intelligence-high-to-low"; readonly CodingHighToLow: "coding-high-to-low"; readonly AgenticHighToLow: "agentic-high-to-low"; readonly FinanceAndAccountingHighToLow: "finance-and-accounting-high-to-low"; readonly StrategyAndOpsHighToLow: "strategy-and-ops-high-to-low"; readonly LegalHighToLow: "legal-high-to-low"; readonly HealthcareAndMedicalHighToLow: "healthcare-and-medical-high-to-low"; readonly EngineeringHighToLow: "engineering-high-to-low"; readonly EconomicsHighToLow: "economics-high-to-low"; readonly CyberHighToLow: "cyber-high-to-low"; readonly OpennessHighToLow: "openness-high-to-low"; readonly MultilingualHighToLow: "multilingual-high-to-low"; readonly DecisionHighToLow: "decision-high-to-low"; readonly DesignArenaEloHighToLow: "design-arena-elo-high-to-low"; }; /** * Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), -high-to-low for each Artificial Analysis index (the coding and agentic sorts are deprecated: Artificial Analysis has retired those indexes, so they order by canonical slug and variant alone), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. The decision sort ranks decision models, so pass output_modalities=decisions or all with it. When omitted, the existing default ordering is preserved. */ export type GetModelsSort = OpenEnum; /** * Filter by distillation capability. "true" returns only distillable models, "false" excludes them. */ export declare const Distillable: { readonly True: "true"; readonly False: "false"; }; /** * Filter by distillation capability. "true" returns only distillable models, "false" excludes them. */ export type Distillable = OpenEnum; /** * When set to "true", return only models with zero data retention endpoints. */ export declare const Zdr: { readonly True: "true"; }; /** * When set to "true", return only models with zero data retention endpoints. */ export type Zdr = ClosedEnum; /** * Filter to models with endpoints in the given data region ("eu" or "us"). */ export declare const Region: { readonly Eu: "eu"; readonly Us: "us"; }; /** * Filter to models with endpoints in the given data region ("eu" or "us"). */ export type Region = OpenEnum; export type GetModelsRequest = { /** * The app identifier should be your app's URL and is used as the primary identifier for rankings. * * @remarks * This is used to track API usage per application. */ httpReferer?: string | undefined; /** * The app display name allows you to customize how your app appears in OpenRouter's dashboard. * * @remarks */ appTitle?: string | undefined; /** * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings. * * @remarks */ appCategories?: string | undefined; /** * Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned */ offset?: number | null | undefined; /** * Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned */ limit?: number | undefined; /** * Filter models by use case category */ category?: GetModelsCategory | undefined; /** * Filter models by supported parameter (comma-separated) */ supportedParameters?: string | undefined; /** * Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". */ outputModalities?: string | undefined; /** * Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), -high-to-low for each Artificial Analysis index (the coding and agentic sorts are deprecated: Artificial Analysis has retired those indexes, so they order by canonical slug and variant alone), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. The decision sort ranks decision models, so pass output_modalities=decisions or all with it. When omitted, the existing default ordering is preserved. */ sort?: GetModelsSort | undefined; /** * Free-text search by model name or slug. */ q?: string | undefined; /** * Filter models by input modality. Comma-separated list of: text, image, audio, file. */ inputModalities?: string | undefined; /** * Filter models by the request API paths they serve, as listed in each model's `endpoints` field. Comma-separated; a model must serve every listed path. Valid values: /api/v1/chat/completions, /api/v1/completions, /api/v1/messages, /api/v1/responses, /api/v1/embeddings, /api/v1/rerank, /api/alpha/decisions, /api/alpha/extractions, /api/v1/videos, /api/v1/audio/speech, /api/v1/audio/transcriptions, /api/v1/images, /api/v1/batches. When set without `output_modalities`, models of every output modality are considered (the companion `/api/alpha/extractions` route is served by text and decisions models alike). */ endpoints?: string | undefined; /** * Minimum context length (tokens). Models with smaller context are excluded. */ context?: number | undefined; /** * Minimum prompt price in $/M tokens. */ minPrice?: number | null | undefined; /** * Maximum prompt price in $/M tokens. */ maxPrice?: number | null | undefined; /** * Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). */ arch?: string | undefined; /** * Filter models by the organization that created the model. Comma-separated list of author slugs. */ modelAuthors?: string | undefined; /** * Filter models by hosting provider. Comma-separated list of provider names. */ providers?: string | undefined; /** * Filter by distillation capability. "true" returns only distillable models, "false" excludes them. */ distillable?: Distillable | undefined; /** * When set to "true", return only models with zero data retention endpoints. */ zdr?: Zdr | undefined; /** * Filter to models with endpoints in the given data region ("eu" or "us"). */ region?: Region | undefined; /** * Minimum completion (output) price in $/M tokens. */ minOutputPrice?: number | null | undefined; /** * Maximum completion (output) price in $/M tokens. */ maxOutputPrice?: number | null | undefined; /** * Minimum model age in days since its creation date. */ minAgeDays?: number | null | undefined; /** * Maximum model age in days since its creation date. */ maxAgeDays?: number | null | undefined; /** * Minimum Artificial Analysis Intelligence Index score (0-100); unscored models are excluded. */ minIntelligenceIndex?: number | null | undefined; /** * Maximum Artificial Analysis Intelligence Index score (0-100); unscored models are excluded. */ maxIntelligenceIndex?: number | null | undefined; /** * Deprecated: Artificial Analysis has retired its Coding Index; no model has a score, so this matches no model. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ minCodingIndex?: number | null | undefined; /** * Deprecated: Artificial Analysis has retired its Coding Index; no model has a score, so this matches no model. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ maxCodingIndex?: number | null | undefined; /** * Deprecated: Artificial Analysis has retired its Agentic Index; no model has a score, so this matches no model. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ minAgenticIndex?: number | null | undefined; /** * Deprecated: Artificial Analysis has retired its Agentic Index; no model has a score, so this matches no model. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ maxAgenticIndex?: number | null | undefined; /** * Minimum Artificial Analysis Finance & Accounting Index score (0-100); unscored models are excluded. */ minFinanceAndAccountingIndex?: number | null | undefined; /** * Maximum Artificial Analysis Finance & Accounting Index score (0-100); unscored models are excluded. */ maxFinanceAndAccountingIndex?: number | null | undefined; /** * Minimum Artificial Analysis Strategy & Ops Index score (0-100); unscored models are excluded. */ minStrategyAndOpsIndex?: number | null | undefined; /** * Maximum Artificial Analysis Strategy & Ops Index score (0-100); unscored models are excluded. */ maxStrategyAndOpsIndex?: number | null | undefined; /** * Minimum Artificial Analysis Legal Index score (0-100); unscored models are excluded. */ minLegalIndex?: number | null | undefined; /** * Maximum Artificial Analysis Legal Index score (0-100); unscored models are excluded. */ maxLegalIndex?: number | null | undefined; /** * Minimum Artificial Analysis Healthcare & Medical Index score (0-100); unscored models are excluded. */ minHealthcareAndMedicalIndex?: number | null | undefined; /** * Maximum Artificial Analysis Healthcare & Medical Index score (0-100); unscored models are excluded. */ maxHealthcareAndMedicalIndex?: number | null | undefined; /** * Minimum Artificial Analysis Engineering Index score (0-100); unscored models are excluded. */ minEngineeringIndex?: number | null | undefined; /** * Maximum Artificial Analysis Engineering Index score (0-100); unscored models are excluded. */ maxEngineeringIndex?: number | null | undefined; /** * Minimum Artificial Analysis Economics Index score (0-100); unscored models are excluded. */ minEconomicsIndex?: number | null | undefined; /** * Maximum Artificial Analysis Economics Index score (0-100); unscored models are excluded. */ maxEconomicsIndex?: number | null | undefined; /** * Minimum Artificial Analysis Cyber Index score (0-100); unscored models are excluded. */ minCyberIndex?: number | null | undefined; /** * Maximum Artificial Analysis Cyber Index score (0-100); unscored models are excluded. */ maxCyberIndex?: number | null | undefined; /** * Minimum Artificial Analysis Openness Index score (0-100); unscored models are excluded. */ minOpennessIndex?: number | null | undefined; /** * Maximum Artificial Analysis Openness Index score (0-100); unscored models are excluded. */ maxOpennessIndex?: number | null | undefined; /** * Minimum Artificial Analysis Multilingual Index score (0-1); unscored models are excluded. */ minMultilingualIndex?: number | null | undefined; /** * Maximum Artificial Analysis Multilingual Index score (0-1); unscored models are excluded. */ maxMultilingualIndex?: number | null | undefined; /** * Minimum Artificial Analysis Decision Index score (0-100); unscored models are excluded. */ minDecisionIndex?: number | null | undefined; /** * Maximum Artificial Analysis Decision Index score (0-100); unscored models are excluded. */ maxDecisionIndex?: number | null | undefined; /** * Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). */ minToolSuccessRate?: number | null | undefined; /** * Maximum tool-calling success rate, as a fraction in [0, 1]. */ maxToolSuccessRate?: number | null | undefined; }; export type GetModelsResponse = { result: models.ModelsListResponse; }; /** @internal */ export declare const GetModelsCategory$outboundSchema: z.ZodType; /** @internal */ export declare const GetModelsSort$outboundSchema: z.ZodType; /** @internal */ export declare const Distillable$outboundSchema: z.ZodType; /** @internal */ export declare const Zdr$outboundSchema: z.ZodEnum; /** @internal */ export declare const Region$outboundSchema: z.ZodType; /** @internal */ export type GetModelsRequest$Outbound = { "HTTP-Referer"?: string | undefined; appTitle?: string | undefined; appCategories?: string | undefined; offset: number | null; limit: number; category?: string | undefined; supported_parameters?: string | undefined; output_modalities?: string | undefined; sort?: string | undefined; q?: string | undefined; input_modalities?: string | undefined; endpoints?: string | undefined; context?: number | undefined; min_price?: number | null | undefined; max_price?: number | null | undefined; arch?: string | undefined; model_authors?: string | undefined; providers?: string | undefined; distillable?: string | undefined; zdr?: string | undefined; region?: string | undefined; min_output_price?: number | null | undefined; max_output_price?: number | null | undefined; min_age_days?: number | null | undefined; max_age_days?: number | null | undefined; min_intelligence_index?: number | null | undefined; max_intelligence_index?: number | null | undefined; min_coding_index?: number | null | undefined; max_coding_index?: number | null | undefined; min_agentic_index?: number | null | undefined; max_agentic_index?: number | null | undefined; min_finance_and_accounting_index?: number | null | undefined; max_finance_and_accounting_index?: number | null | undefined; min_strategy_and_ops_index?: number | null | undefined; max_strategy_and_ops_index?: number | null | undefined; min_legal_index?: number | null | undefined; max_legal_index?: number | null | undefined; min_healthcare_and_medical_index?: number | null | undefined; max_healthcare_and_medical_index?: number | null | undefined; min_engineering_index?: number | null | undefined; max_engineering_index?: number | null | undefined; min_economics_index?: number | null | undefined; max_economics_index?: number | null | undefined; min_cyber_index?: number | null | undefined; max_cyber_index?: number | null | undefined; min_openness_index?: number | null | undefined; max_openness_index?: number | null | undefined; min_multilingual_index?: number | null | undefined; max_multilingual_index?: number | null | undefined; min_decision_index?: number | null | undefined; max_decision_index?: number | null | undefined; min_tool_success_rate?: number | null | undefined; max_tool_success_rate?: number | null | undefined; }; /** @internal */ export declare const GetModelsRequest$outboundSchema: z.ZodType; export declare function getModelsRequestToJSON(getModelsRequest: GetModelsRequest): string; /** @internal */ export declare const GetModelsResponse$inboundSchema: z.ZodType; export declare function getModelsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getmodels.d.ts.map