> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a Smart Router > Retrieves a Smart Router by ID from the current workspace, including its model reference, model pool, routing profile, and enabled state. ## OpenAPI ````yaml get /v2/smart-routers/{smart_router_id} openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://api.orq.ai security: - ApiKey: [] tags: - description: List models available through the AI Router. name: Models - name: Guardrail Rules - name: Policies - name: Routing Rules - name: Activities description: Activity timeline entries for comments and entity versions. - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: API keys description: >- API keys authenticate programmatic access to the workspace. The unified key model exposes opaque tokens, per-domain access grants, and budget / rate-limit constraints (see ADR 0001 and ADR 0002). - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, api-key, provider, and model. A budget is hierarchical and defense-in-depth — every applicable budget is a hard gate, and the most restrictive one wins per dimension (see ADR 0007). - name: Documentation description: >- Search the orq.ai documentation. Proxies the workspace's query to the hosted docs search index. - name: FeaturePreviews description: >- Internal: list and toggle per-user feature previews (beta features users can opt into). - name: Files description: File upload and retrieval operations. - name: Finder description: >- Finder entities back the studio navigation tree, project switcher, and cross-project resource references. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Manage upstream MCP servers and client-facing MCP gateways. Create server connections, discover tools, assemble gateways, and review call logs. - name: Model Sharing description: >- Model sharing controls which projects a workspace model is available to. Workspace admins configure a model's Sharing (all projects / selected projects); the config ships inline on the models list response, so there is no separate read endpoint. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: People description: >- People are workspace members and invited users. Manage roles, groups, and invitations for your team. - name: Projects description: Projects organize resources within a workspace - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/smart-routers/{smart_router_id}: get: tags: - Smart Routers summary: Retrieve a Smart Router description: >- Retrieves a Smart Router by ID from the current workspace, including its model reference, model pool, routing profile, and enabled state. operationId: SmartRouterGet parameters: - name: smart_router_id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetSmartRouterResponse' x-code-samples: - lang: curl label: Core - Retrieve a Smart Router source: | curl --request GET \ --url 'https://api.orq.ai/v2/smart-routers/019d-smart-router-id' \ --header 'Authorization: Bearer $ORQ_API_KEY' - lang: typescript label: Node.js - Retrieve a Smart Router source: | import { Orq } from '@orq-ai/node'; const client = new Orq({ apiKey: process.env.ORQ_API_KEY }); const result = await client.smartRouters.get({ smartRouterId: '019d-smart-router-id', }); console.log(result.smartRouter.key); components: schemas: GetSmartRouterResponse: required: - smart_router type: object properties: smart_router: $ref: '#/components/schemas/SmartRouter' SmartRouter: required: - smart_router_id - key - model_ref - models - profile - enabled - created_at - updated_at type: object properties: smart_router_id: type: string description: Unique identifier assigned to the Smart Router. key: type: string description: >- Immutable lowercase key that identifies the Smart Router within the workspace. model_ref: type: string description: >- Immutable workspace-qualified model reference to use in AI Gateway requests, in `@orq/` format. models: type: array items: type: string description: >- Pool of 2 to 50 distinct eligible models. Each value uses `provider/model` format. profile: $ref: '#/components/schemas/SmartRouterProfile' description: >- Routing preference: quality favors more capable models, cost favors less expensive models, and balanced trades off both. enabled: type: boolean description: Whether the Smart Router can be used in AI Gateway requests. created_at: type: string format: date-time description: Date and time when the Smart Router was created. updated_at: type: string format: date-time description: Date and time when the Smart Router was last updated. metrics: $ref: '#/components/schemas/SmartRouterMetrics' SmartRouterProfile: type: string enum: - SMART_ROUTER_PROFILE_UNSPECIFIED - SMART_ROUTER_PROFILE_QUALITY - SMART_ROUTER_PROFILE_BALANCED - SMART_ROUTER_PROFILE_COST SmartRouterMetrics: required: - requests - spend - traffic type: object properties: requests: type: number description: Total gateway requests served by the router over the window. format: double spend: type: number description: Total cost in USD attributed to the router over the window. format: double traffic: type: object additionalProperties: type: number format: double description: Requests per selected model, keyed by the provider/model reference. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````