> ## Documentation Index > Fetch the complete documentation index at: /docs/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. > [!NOTE] > > **Related guide**: Routing rules guide. See the [Routing rules guide](/docs/ai-gateway/configuration/routing-rules.md) for a walkthrough with examples. ## OpenAPI ````yaml get /v2/smart-routers/{smart_router_id} openapi: 3.1.0 info: title: Toqan Router API version: '2.0' description: Toqan Router API documentation servers: - url: https://router.toqan.ai/eu description: Frankfurt (Europe) - url: https://router.toqan.ai/br description: São Paulo (Brazil) security: - ApiKey: [] tags: - description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. name: API keys - 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: Telemetry description: >- Unified query envelope for traces, metrics, and logs. One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - name: Views description: Saved filters and columns for workspace observability pages. - description: List models available through the AI Router. name: Models - name: Alerts description: >- Alerts evaluate a telemetry 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: Annotation Queues description: Annotation queues collect spans for human review. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - 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: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the Toqan Router model catalog: every model Toqan Router offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Monitors description: >- Monitors are custom observability dashboards for traces, runtime metrics, and logs. Each monitor holds widgets that chart one telemetry query. List the metrics, operations, and dimensions available to your workspace with `GET /v3/telemetry/capabilities`, or start from a preset with `GET /v2/monitors/presets`. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - 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: Responses - name: Embeddings - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Beta. Run classification decisions with the classify contract. name: Decisions - description: >- Run large offline workloads as JSONL batches and download OpenAI-compatible result files. name: Batches 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' '401': description: >- Authentication required. See https://router.toqan.ai/docs/reference/errors for the error codes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Not permitted for this key, project or workspace. See https://router.toqan.ai/docs/reference/errors for the error codes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKey: [] x-code-samples: - lang: curl label: Core - Retrieve a Smart Router source: | curl --request GET \ --url 'https://router.toqan.ai/eu/v2/smart-routers/019d-smart-router-id' \ --header "Authorization: Bearer $TOQAN_API_KEY" components: schemas: GetSmartRouterResponse: required: - smart_router type: object properties: smart_router: $ref: '#/components/schemas/SmartRouter' ErrorResponse: type: object properties: message: type: string description: Human-readable error message. code: type: integer description: Numeric error code, when one is available. details: type: array items: {} description: Additional error details, when the service reports any. required: - message 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 description: Date and time when the Smart Router was created. format: date-time updated_at: type: string description: Date and time when the Smart Router was last updated. format: date-time session_affinity: $ref: '#/components/schemas/SmartRouterSessionAffinity' SmartRouterProfile: type: string enum: - SMART_ROUTER_PROFILE_QUALITY - SMART_ROUTER_PROFILE_BALANCED - SMART_ROUTER_PROFILE_COST SmartRouterSessionAffinity: required: - enabled type: object properties: enabled: description: >- Whether later turns of a thread stay on the model chosen for its first turn. Only requests that carry a thread id take part. Off by default. type: boolean ttl_seconds: maximum: 3600 minimum: 60 type: integer description: >- Sliding idle window in seconds. A thread that stays quiet longer than this is routed afresh on its next turn. Between 60 and 3600. Defaults to 600 when omitted. format: int32 securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.