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

# Read the account's model pool configuration

> An account with no config yet gets `{}` so the UI renders the default state (all providers enabled, default models). A *failed* read answers 502: the UI draws defaults from an empty body, and the user's next Save would post those defaults over a config that was fine, losing every custom provider and tier pin.

Custom provider credentials come back as `auth_key_ref` (a `SECRET::<name>::` reference) — the raw key is never returned. Subject: `microstrate.hub.get.agent-model-pool`.



## OpenAPI

````yaml /api-reference/endpoint/abbie/openapi.json get /hub/agent/model-pool
openapi: 3.1.0
info:
  title: Abbie API (beta)
  version: 1.0.0
  description: >
    **Beta.** This API is in beta: operations and fields may change without a
    deprecation period. Do not depend on undocumented fields. It covers the
    subset of Abbie's API used by the Quiva coworker MCP server: skills, todos,
    memory, profile, corrections, environment and models.


    HTTP surface of hub-service for Abbie/Coworker configuration, agent rapport
    & context, chat-session sharing, and MCP registration.


    ## Transport and response envelope


    Every operation here is a gateway mapping onto a Bellerophon/kraken subject
    of the form `microstrate.hub.<method>.<endpoint-slug>` (see
    `hub-service/service/service.go` and `docs/abbie-gateway-mappings.md`).
    Handlers reply on the mesh with an envelope `{"status_code": <int>, "body":
    <object>}`; the gateway unwraps it, so `status_code` becomes the HTTP status
    and `body` becomes the HTTP response body. **The schemas below describe the
    unwrapped `body`.**


    Errors are always `{"error": "<message>"}` with the matching HTTP status.


    ## Parameter conventions


    The gateway forwards URL parameters to the handler as request headers:


    - `x-param-query-<name>` — a query-string parameter (`?name=value`)

    - `x-param-<name>` — a path parameter


    Every parameter documented as `in: query` or `in: path` below corresponds to
    one of those headers, and the header suffix is named in each parameter's
    description where it is not obvious.


    ## Authentication


    All operations require the caller's bearer token; the account id, user id
    and user public key are always taken from the JWT and never from the URL or
    body. Endpoints that additionally require an account **admin** role are
    marked in their description — a failed role lookup answers **502**, never
    403 and never a pass.


    ## Two path notes


    - `PATCH /hub/agent-session-visibility/{session_id}` — the handler reads the
    path parameter as `x-param-session_id`, matching its sibling `PATCH
    /hub/agent-session/{session_id}`.

    - `GET|POST|PUT /hub/agent/user-context/{id}` — the handler requires the
    **agent id** as `x-param-id`; the frontend calls
    `/hub/agent/user-context/<agentId>`.
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Skills
  - name: Todos
  - name: Memory
  - name: Profile and personality
  - name: Corrections
  - name: Environment
  - name: Models
paths:
  /hub/agent/model-pool:
    get:
      tags:
        - Models
      summary: Read the account's model pool configuration
      description: >-
        An account with no config yet gets `{}` so the UI renders the default
        state (all providers enabled, default models). A *failed* read answers
        502: the UI draws defaults from an empty body, and the user's next Save
        would post those defaults over a config that was fine, losing every
        custom provider and tier pin.


        Custom provider credentials come back as `auth_key_ref` (a
        `SECRET::<name>::` reference) — the raw key is never returned. Subject:
        `microstrate.hub.get.agent-model-pool`.
      operationId: getModelPool
      responses:
        '200':
          description: The stored config, redacted; `{}` when none exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPoolConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    ModelPoolConfig:
      type: object
      description: >-
        The account's provider/model routing configuration. A GET on an account
        with no config returns `{}`.
      properties:
        active_providers:
          type: array
          items:
            type: string
        routing_mode:
          type: string
          enum:
            - ''
            - cost
            - balanced
            - performance
            - accuracy
          description: >-
            Sovereignty is not a routing mode — it is orthogonal to this axis
            and is configured by the `sovereign` block, which composes with any
            mode here.
        processing_speed:
          type: string
          enum:
            - ''
            - standard
            - fast
          description: >-
            Omitted on PUT means unchanged; send "" to reset the account to
            standard speed.
        expert_strategy:
          type: string
        judge_quorum:
          type: integer
        coworker_run_timeout_minutes:
          type: integer
          minimum: 0
          maximum: 60
          description: >-
            Minutes, 5–60. 0 means the 30-minute default. Deliberately an int,
            never a duration string.
        model_routing:
          type: object
          additionalProperties:
            type: string
        stage_models:
          type: object
          additionalProperties:
            type: string
        custom_providers:
          type: array
          items:
            $ref: '#/components/schemas/CustomProvider'
        sovereign:
          $ref: '#/components/schemas/SovereignConfig'
        provider_keys:
          type: object
          additionalProperties:
            type: string
          description: >-
            Builtin provider key (`anthropic`/`openai`/`gemini`, later `scx`) to
            a `SECRET::<name>::` reference for that provider's own key. Unlike
            `CustomProvider.auth_key`, a value must already be a well-formed
            reference — there is no raw-key reconciliation path for this field.
    CustomProvider:
      type: object
      properties:
        name:
          type: string
        endpoint:
          type: string
          format: uri
          description: OpenAI-compatible base URL
        auth_type:
          type: string
          enum:
            - api_key
            - bearer
        auth_key:
          type: string
          description: >-
            Write-only. A raw key is moved into the account's secrets bucket on
            save and replaced by `auth_key_ref`; a `SECRET::<name>::` reference
            is stored verbatim. Never returned.
        auth_key_ref:
          type: string
          description: >-
            The stored `SECRET::<name>::` reference. What GET returns in place
            of `auth_key`.
          readOnly: true
        models:
          type: array
          items:
            $ref: '#/components/schemas/CustomModel'
          description: >-
            The legacy shape (`["model-a", "model-b"]` with provider-level
            capability flags) is still accepted on write and still parses out of
            previously stored aggregates; writes always store the object shape.
        supports_tools:
          type: boolean
          description: Legacy provider-level flag
        supports_vision:
          type: boolean
          description: Legacy provider-level flag
    SovereignConfig:
      type: object
      description: >-
        The account's sovereign-routing boundary. Omitted on PUT means unchanged
        — the stored boundary is preserved; send an explicit empty object to
        clear it. `providers` is intersected with `active_providers` to form the
        boundary every routing decision filters on; leaving it empty falls back
        to `active_providers` alone.
      properties:
        providers:
          type: array
          items:
            type: string
          description: >-
            Entries must be non-empty. The boundary the router enforces is
            `active_providers` intersected with this list — see `enforcement`.
        enforcement:
          type: string
          enum:
            - ''
            - preferred
            - strict
          description: >-
            Empty means "preferred" — a crossing is allowed, not blocked.
            "strict" is live in the router: it makes the boundary absolute, so a
            request that cannot be served from inside it fails instead of
            reaching outside it. The boundary is `active_providers` intersected
            with `providers`; a provider must be in both. A strict boundary that
            is empty, or whose two lists share nothing, is rejected on save.
            Scenario matching is not built, so a strict boundary binds every
            request rather than only a matched scenario.
        scenarios:
          type: array
          items:
            $ref: '#/components/schemas/SovereignScenario'
          description: Stored only — scenario matching is not built.
        regions:
          type: array
          items:
            type: string
          description: >-
            ISO-3166 alpha-2 country codes, UPPERCASE (e.g. `["AU"]`). Entries
            must be exactly two uppercase letters — not silently upper-cased.
            Empty/absent means no residency constraint. Composes with
            `providers` and `enforcement`; does not replace them.
    Error:
      type: object
      description: The unwrapped error body. The HTTP status carries the code.
      properties:
        error:
          type: string
      required:
        - error
    CustomModel:
      type: object
      properties:
        name:
          type: string
        display_name:
          type: string
        best_for:
          type: string
        reasoning_category:
          type: string
        supports_tools:
          type: boolean
        supports_vision:
          type: boolean
        supports_voice:
          type: boolean
        supports_video:
          type: boolean
        supports_thinking:
          type: boolean
        supports_streaming:
          type: boolean
        supports_sampling_params:
          type: boolean
        routing_tiers:
          type: array
          items:
            type: string
        context_window:
          type: integer
        max_output_tokens:
          type: integer
        task_strengths:
          type: array
          items:
            type: string
        input_cost_per_1m:
          type: number
        output_cost_per_1m:
          type: number
        release_date:
          type: string
    SovereignScenario:
      type: object
      description: >-
        One circumstance in which sovereign routing binds. Stored only — nothing
        evaluates these yet.
      properties:
        name:
          type: string
          description: Required when the scenario is present.
        condition:
          type: string
          description: Natural-language condition evaluated by the classifier.
  responses:
    Unauthorized:
      description: No account (or user) identity in the auth context
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UpstreamError:
      description: >-
        A backend read or write failed — deliberately not degraded to an empty
        or default answer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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