> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar modelos do workspace

> Lists all available models for the workspace, including system and custom models with their enabled status.

> [!NOTE]
>
> **Guia relacionado**: guia de AI Gateway. Consulte o [guia de AI Gateway](/docs/pt-BR/ai-gateway/using-the-router.md) para um passo a passo com exemplos.


## OpenAPI

````yaml get /v2/models
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/models:
    get:
      tags:
        - Models
      summary: List models
      description: >-
        Lists all available models for the workspace, including system and
        custom models with their enabled status.
      operationId: ModelList
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ModelDocument'
                type:
                  - array
                  - 'null'
          description: Models retrieved successfully
        '401':
          description: Unauthorized
      security:
        - ApiKey: []
      x-code-samples: []
components:
  schemas:
    ModelDocument:
      additionalProperties: false
      properties:
        configuration:
          $ref: '#/components/schemas/ModelConfigurationResponse'
        created:
          type: string
        description:
          type:
            - string
            - 'null'
        display_name:
          type: string
        docs_url:
          type:
            - string
            - 'null'
        enabled:
          type: boolean
        enabled_for_endpoints:
          type: boolean
        enabled_for_playground:
          type: boolean
        has_cpu_pricing:
          type: boolean
        has_functions:
          type: boolean
        id:
          type: string
        input_cost:
          format: double
          type:
            - number
            - 'null'
        input_currency:
          type: string
        is_active:
          type: boolean
        legacy_uuid:
          deprecated: true
          type: string
        metadata:
          $ref: '#/components/schemas/ModelMetadata'
        model_developer:
          type: string
        model_family:
          type: string
        model_id:
          type: string
        model_type:
          type: string
        output_cost:
          format: double
          type:
            - number
            - 'null'
        output_currency:
          type: string
        owner:
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/ModelParameterDocument'
          type:
            - array
            - 'null'
        pricing_url:
          type:
            - string
            - 'null'
        provider:
          type: string
        refId:
          type: string
        sharing:
          $ref: '#/components/schemas/ModelSharingConfig'
        updated:
          type: string
      required:
        - id
        - created
        - updated
        - display_name
        - model_id
        - is_active
        - provider
        - owner
        - input_cost
        - input_currency
        - output_cost
        - output_currency
        - description
        - pricing_url
        - docs_url
        - model_type
        - has_functions
        - has_cpu_pricing
        - enabled_for_playground
        - enabled_for_endpoints
        - configuration
        - metadata
        - parameters
        - enabled
        - refId
      type: object
    ModelConfigurationResponse:
      additionalProperties: false
      properties:
        api_key_env:
          type: string
        api_version:
          type: string
        auth_mode:
          type: string
        auth_type:
          type: string
        base_url:
          type: string
        deployment_name:
          type: string
        endpoint:
          type: string
        inference_profile_arn:
          type: string
        integration_id:
          type: string
        is_openai_compatible:
          type: boolean
        is_tuned_model:
          type: boolean
        location:
          type: string
        model_id:
          type: string
        project_id:
          type: string
        provider:
          type: string
        region:
          type: string
        should_use_beta_features:
          type: boolean
        subtype:
          type: string
        workspace_id:
          type: string
      required:
        - provider
      type: object
    ModelMetadata:
      additionalProperties: false
      properties:
        allowed_passthrough_parameters:
          items:
            type: string
          type:
            - array
            - 'null'
        autorouter:
          $ref: '#/components/schemas/AutoRouterConfig'
        batch_endpoints:
          items:
            type: string
          type:
            - array
            - 'null'
        cached_image_input_cost:
          type: number
          format: double
        cached_input_cost:
          type: number
          format: double
        chain_of_thought:
          type: boolean
        context_length:
          format: int64
          type: integer
        context_window:
          format: int64
          type: integer
        cost_efficiency_rating:
          format: int64
          type: integer
        cost_per_image:
          type: number
          format: double
        default_max_output_tokens:
          format: int64
          type: integer
        default_speech_response_format:
          type: string
        deprecation_date:
          type: string
        embedding_dimensions:
          format: int64
          type: integer
        extended_context_pricing_mode:
          type: string
        extended_context_threshold:
          format: int64
          type: integer
        function_tools_require_effort_none:
          type: boolean
        fusion:
          $ref: '#/components/schemas/ModelFusionConfig'
        generate_audio:
          type: boolean
        image_input_cost:
          type: number
          format: double
        image_output_cost:
          type: number
          format: double
        image_token_cost:
          type: number
          format: double
        intelligence_rating:
          format: int64
          type: integer
        is_private:
          type: boolean
        is_realtime:
          type: boolean
        knowledge_cutoff:
          type: string
        max_images_per_request:
          format: int64
          type: integer
        max_input_tokens:
          format: int64
          type: integer
        max_output_tokens:
          format: int64
          type: integer
        max_temperature:
          type: number
          format: double
        million_fetches_cost:
          type: number
          format: double
        million_searches_cost:
          type: number
          format: double
        million_tokens_above_128k_cache_read_cost:
          type: number
          format: double
        million_tokens_above_128k_cache_write_cost:
          type: number
          format: double
        million_tokens_above_128k_input_cost:
          type: number
          format: double
        million_tokens_above_128k_output_cost:
          type: number
          format: double
        million_tokens_above_200k_cache_read_cost:
          type: number
          format: double
        million_tokens_above_200k_cache_write_cost:
          type: number
          format: double
        million_tokens_above_200k_input_cost:
          type: number
          format: double
        million_tokens_above_200k_output_cost:
          type: number
          format: double
        million_tokens_audio_input_cost:
          type: number
          format: double
        million_tokens_audio_output_cost:
          type: number
          format: double
        million_tokens_batches_input_cost:
          type: number
          format: double
        million_tokens_batches_output_cost:
          type: number
          format: double
        million_tokens_cache_read_cost:
          type: number
          format: double
        million_tokens_cache_write_1h_cost:
          type: number
          format: double
        million_tokens_cache_write_5m_cost:
          type: number
          format: double
        million_tokens_cache_write_cost:
          type: number
          format: double
        million_tokens_input_cost:
          type: number
          format: double
        million_tokens_output_cost:
          type: number
          format: double
        million_tokens_reasoning_cost:
          type: number
          format: double
        multilingual:
          type: boolean
        offline:
          type: boolean
        per_video_second_cost:
          type: number
          format: double
        per_video_second_cost_1080p:
          type: number
          format: double
        pricing:
          $ref: '#/components/schemas/Pricing'
        reasoning_cost:
          type: number
          format: double
        reasoning_tokens:
          format: int64
          type: integer
        region:
          type: string
        speed_rating:
          format: int64
          type: integer
        supported_embedding_dimensions:
          $ref: '#/components/schemas/EmbeddingDimensionSupport'
        supported_video_aspect_ratios:
          items:
            type: string
          type:
            - array
            - 'null'
        supported_video_durations:
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        supported_video_frame_images:
          items:
            type: string
          type:
            - array
            - 'null'
        supported_video_resolutions:
          items:
            type: string
          type:
            - array
            - 'null'
        supported_video_sizes:
          items:
            type: string
          type:
            - array
            - 'null'
        supports_adaptive_reasoning:
          type: boolean
        supports_audio_input:
          type: boolean
        supports_audio_output:
          type: boolean
        supports_b64_json_response_format:
          type: boolean
        supports_batch_api:
          type: boolean
        supports_cache_control:
          type: boolean
        supports_citations:
          type: boolean
        supports_classify:
          type: boolean
        supports_code_execution:
          type: boolean
        supports_commercial_use:
          type: boolean
        supports_computer_use:
          type: boolean
        supports_developer_message:
          type: boolean
        supports_direct_cost:
          type: boolean
        supports_distillation:
          type: boolean
        supports_extended_thinking:
          type: boolean
        supports_fine_tuning:
          type: boolean
        supports_google_realtime_api:
          type: boolean
        supports_image_edit:
          type: boolean
        supports_image_input:
          type: boolean
        supports_image_output:
          type: boolean
        supports_images:
          type: boolean
        supports_json_mode_response_format:
          type: boolean
        supports_json_schema_response_format:
          type: boolean
        supports_max_completion_tokens:
          type: boolean
        supports_mid_conversation_system:
          type: boolean
        supports_native_classify:
          type: boolean
        supports_openai_realtime_api:
          type: boolean
        supports_openai_sdk:
          type: boolean
        supports_parallel_tool_calls:
          type: boolean
        supports_pdf_input:
          type: boolean
        supports_prompt_caching:
          type: boolean
        supports_reasoning:
          type: boolean
        supports_reasoning_effort_default:
          type: boolean
        supports_reasoning_effort_high:
          type: boolean
        supports_reasoning_effort_instant:
          type: boolean
        supports_reasoning_effort_low:
          type: boolean
        supports_reasoning_effort_max:
          type: boolean
        supports_reasoning_effort_medium:
          type: boolean
        supports_reasoning_effort_minimal:
          type: boolean
        supports_reasoning_effort_none:
          type: boolean
        supports_reasoning_effort_xhigh:
          type: boolean
        supports_responses_api:
          type: boolean
        supports_sampling_params:
          type: boolean
        supports_service_tier:
          type: boolean
        supports_streaming:
          type: boolean
        supports_strict_tool:
          type: boolean
        supports_structured_outputs:
          type: boolean
        supports_system_message:
          type: boolean
        supports_text:
          type: boolean
        supports_text_input:
          type: boolean
        supports_text_output:
          type: boolean
        supports_thinking_level:
          type: boolean
        supports_thinking_level_low:
          type: boolean
        supports_thinking_level_medium:
          type: boolean
        supports_thinking_level_minimal:
          type: boolean
        supports_tool_calling:
          type: boolean
        supports_tool_choice:
          type: boolean
        supports_transcription:
          type: boolean
        supports_url_context:
          type: boolean
        supports_url_response_format:
          type: boolean
        supports_video_input:
          type: boolean
        supports_video_output:
          type: boolean
        supports_video_seed:
          type: boolean
        supports_vision:
          type: boolean
        supports_web_search:
          type: boolean
        supports_zdr:
          type: boolean
        thinking_enforced:
          type: boolean
      required:
        - is_private
      type: object
    ModelParameterDocument:
      additionalProperties: false
      properties:
        config:
          type: object
          additionalProperties: {}
        description:
          type:
            - string
            - 'null'
        hints:
          type: string
        id:
          type: string
        is_active:
          type: boolean
        name:
          type: string
        parameter:
          type: string
        parameter_type:
          type: string
        position:
          format: int64
          type: integer
      required:
        - id
        - name
        - parameter
        - description
        - config
        - parameter_type
        - is_active
      type: object
    ModelSharingConfig:
      additionalProperties: false
      properties:
        allow_fork:
          type: boolean
        allow_version_pin:
          type: boolean
        auto_grant_new_projects:
          type: boolean
        mode:
          type: string
        project_ids:
          items:
            type: string
          type:
            - array
            - 'null'
      required:
        - mode
        - allow_version_pin
        - allow_fork
        - auto_grant_new_projects
      type: object
    AutoRouterConfig:
      additionalProperties: false
      properties:
        benchmark_model:
          description: >-
            Catalog model whose benchmarks this private model copies to join
            Smart Router pools.
          type: string
        economical_model:
          description: Model used when the router classifies a request as simple.
          type: string
        id:
          description: Identifier of the Smart Router configuration.
          type: string
        models:
          description: Models the router chooses from, written as provider/model_id.
          items:
            type: string
          type:
            - array
            - 'null'
        profile:
          description: 'Routing preference: quality, balanced, or cost.'
          type: string
        session_affinity:
          $ref: '#/components/schemas/SessionAffinityConfig'
          description: >-
            Whether later turns of a thread stay on the model chosen for its
            first turn.
        strong_model:
          description: Model used when the router classifies a request as complex.
          type: string
        v2:
          $ref: '#/components/schemas/AutoRouterV2Config'
          description: Benchmark data each model in the pool is ranked by.
        version:
          description: Version of the Smart Router configuration format.
          type: string
      type: object
    ModelFusionConfig:
      additionalProperties: false
      properties:
        feed_raw_to_synth:
          type: boolean
        id:
          type: string
        judge_model:
          type: string
        max_tool_calls:
          format: int64
          type: integer
        orchestrator_model:
          type: string
        panel_models:
          items:
            type: string
          type:
            - array
            - 'null'
        preset:
          type: string
        synthesis_mode:
          type: string
        web_tools:
          type: boolean
      required:
        - panel_models
        - judge_model
        - synthesis_mode
        - preset
        - web_tools
        - max_tool_calls
        - feed_raw_to_synth
      type: object
    Pricing:
      additionalProperties: false
      properties:
        audio_input:
          $ref: '#/components/schemas/Price'
        audio_output:
          $ref: '#/components/schemas/Price'
        audio_session:
          $ref: '#/components/schemas/Price'
        cache_read:
          $ref: '#/components/schemas/Price'
        cache_write_12h:
          $ref: '#/components/schemas/Price'
        cache_write_1h:
          $ref: '#/components/schemas/Price'
        cache_write_30m:
          $ref: '#/components/schemas/Price'
        cache_write_5m:
          $ref: '#/components/schemas/Price'
        fetch:
          $ref: '#/components/schemas/Price'
        image_cache_read:
          $ref: '#/components/schemas/Price'
        image_input:
          $ref: '#/components/schemas/Price'
        input:
          $ref: '#/components/schemas/Price'
        output:
          $ref: '#/components/schemas/Price'
        reasoning:
          $ref: '#/components/schemas/Price'
        search:
          $ref: '#/components/schemas/Price'
        text_input:
          $ref: '#/components/schemas/Price'
        variants:
          items:
            $ref: '#/components/schemas/PricingVariant'
          type:
            - array
            - 'null'
      type: object
    EmbeddingDimensionSupport:
      additionalProperties: false
      properties:
        max:
          format: int64
          type: integer
        min:
          format: int64
          type: integer
        options:
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
      type: object
    SessionAffinityConfig:
      additionalProperties: false
      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:
          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: int64
          maximum: 3600
          minimum: 60
          type: integer
      required:
        - enabled
      type: object
    AutoRouterV2Config:
      additionalProperties: false
      properties:
        aa_creator:
          $ref: '#/components/schemas/AutoRouterV2CreatorConfig'
          description: Model creator reported by Artificial Analysis.
        aa_evaluations:
          additionalProperties:
            format: double
            type:
              - number
              - 'null'
          description: >-
            Benchmark scores reported by Artificial Analysis, keyed by
            evaluation.
          type: object
        aa_index_is_estimated:
          description: Whether the intelligence index is estimated rather than measured.
          type: boolean
        aa_index_version:
          description: Version of the intelligence index the score came from.
          type: string
        aa_is_reasoning:
          description: >-
            Whether Artificial Analysis classifies the model as a reasoning
            model.
          type: boolean
        aa_median_output_tokens_per_second:
          description: Median output tokens per second measured by Artificial Analysis.
          format: double
          type: number
        aa_median_time_to_first_answer_token:
          description: >-
            Median time to the first answer token measured by Artificial
            Analysis.
          format: double
          type: number
        aa_median_time_to_first_token_seconds:
          description: >-
            Median time to first token in seconds measured by Artificial
            Analysis.
          format: double
          type: number
        aa_model_id:
          description: Artificial Analysis model identifier.
          type: string
        aa_name:
          description: Model name reported by Artificial Analysis.
          type: string
        aa_pricing:
          additionalProperties:
            format: double
            type:
              - number
              - 'null'
          description: Token prices reported by Artificial Analysis, keyed by price type.
          type: object
        aa_reasoning_effort:
          description: Reasoning effort the benchmarked score applies to.
          type: string
        aa_release_date:
          description: Model release date reported by Artificial Analysis.
          type: string
        aa_slug:
          description: Artificial Analysis slug of the model.
          type: string
        default_effort:
          description: Reasoning effort applied when a request does not set one.
          type: string
        default_effort_scored:
          description: Whether the default effort has a benchmarked score.
          type: boolean
        intelligence_index:
          description: >-
            Artificial Analysis intelligence index the router ranks the model
            by.
          format: double
          type: number
        price:
          description: Blended price per million tokens, in USD.
          format: double
          type: number
        reasoning_efforts:
          additionalProperties:
            $ref: '#/components/schemas/AutoRouterV2EffortConfig'
          description: Benchmark data for each reasoning effort the model exposes.
          type: object
      required:
        - intelligence_index
        - price
      type: object
    Price:
      additionalProperties: false
      properties:
        cost:
          type: number
          format: double
        currency:
          type: string
        per:
          format: int64
          type: integer
        unit:
          type: string
      required:
        - cost
        - currency
        - unit
        - per
      type: object
    PricingVariant:
      additionalProperties: false
      properties:
        audio_input:
          $ref: '#/components/schemas/Price'
        audio_output:
          $ref: '#/components/schemas/Price'
        audio_session:
          $ref: '#/components/schemas/Price'
        cache_read:
          $ref: '#/components/schemas/Price'
        cache_write_12h:
          $ref: '#/components/schemas/Price'
        cache_write_1h:
          $ref: '#/components/schemas/Price'
        cache_write_30m:
          $ref: '#/components/schemas/Price'
        cache_write_5m:
          $ref: '#/components/schemas/Price'
        fetch:
          $ref: '#/components/schemas/Price'
        image_cache_read:
          $ref: '#/components/schemas/Price'
        image_input:
          $ref: '#/components/schemas/Price'
        input:
          $ref: '#/components/schemas/Price'
        output:
          $ref: '#/components/schemas/Price'
        reasoning:
          $ref: '#/components/schemas/Price'
        search:
          $ref: '#/components/schemas/Price'
        text_input:
          $ref: '#/components/schemas/Price'
        when:
          type: string
      required:
        - when
      type: object
    AutoRouterV2CreatorConfig:
      additionalProperties: false
      properties:
        id:
          description: Artificial Analysis identifier of the creator.
          type: string
        name:
          description: Creator name reported by Artificial Analysis.
          type: string
        slug:
          description: Artificial Analysis slug of the creator.
          type: string
      required:
        - id
        - name
      type: object
    AutoRouterV2EffortConfig:
      additionalProperties: false
      properties:
        aa_index_is_estimated:
          description: Whether the score at this effort is estimated.
          type: boolean
        aa_index_version:
          description: Version of the intelligence index measured at this effort.
          type: string
        aa_is_reasoning:
          description: Whether the model runs as a reasoning model at this effort.
          type: boolean
        aa_reasoning_effort:
          description: Reasoning effort label Artificial Analysis reports for this entry.
          type: string
        aa_slug:
          description: Artificial Analysis slug of the model at this effort.
          type: string
        intelligence_index:
          description: Intelligence index measured at this effort.
          format: double
          type: number
      required:
        - intelligence_index
      type: object
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.