repowise-dev Providers API

openapi: 3.2.0
info:
  title: repowise Providers API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: Providers
paths:
  /api/providers:
    get:
      tags:
      - Providers
      summary: Get Providers
      description: 'List all providers with their status and active selection.


        Pass ``?repo_id=`` so the active selection reflects that repo''s own

        ``.repowise/config.yaml`` (and any per-repo UI override) instead of the

        server-global default. ``?detect=true`` also asks each agent CLI whether

        it is signed in (a short subprocess each), so it runs off the event loop.'
      operationId: get_providers_api_providers_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      - name: detect
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Detect
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
  /api/providers/active:
    patch:
      tags:
      - Providers
      summary: Set Active
      description: 'Set the active provider, model and base URL.


        With ``repo_id`` the choice is written to that repo''s

        ``.repowise/config.yaml``, which the CLI reads too; without it, the

        server-wide default is set. ``base_url`` left out of the body keeps the

        current endpoint; ``""`` or ``null`` clears it.'
      operationId: set_active_api_providers_active_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetActiveProviderRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
      x-repowise-stability: internal
  /api/providers/{provider_id}/key:
    post:
      tags:
      - Providers
      summary: Add Provider Key
      description: 'Store an API key for a provider.


        With ``repo_id`` in the body, the key is also written to that repo''s

        ``.repowise/.env`` so a subsequent CLI run in the repo uses it.'
      operationId: add_provider_key_api_providers__provider_id__key_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider_id
        in: path
        required: true
        schema:
          type: string
          title: Provider Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetApiKeyRequest'
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
    delete:
      tags:
      - Providers
      summary: Remove Provider Key
      description: 'Remove a provider''s API key.


        With ``?repo_id=``, the key is also cleared from that repo''s

        ``.repowise/.env`` (the mirror written when it was added).'
      operationId: remove_provider_key_api_providers__provider_id__key_delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider_id
        in: path
        required: true
        schema:
          type: string
          title: Provider Id
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
  /api/providers/{provider_id}/validate:
    post:
      tags:
      - Providers
      summary: Validate Provider
      description: 'Live smoke test for a single provider''s configured key.


        Instantiates *this* provider (not the active one) with the key resolved for

        the repo and does a tiny ``generate`` round-trip — the same probe the CLI

        and pre-index preflight use, scoped to one provider so the settings UI can

        confirm a key it just added actually works. A keyless provider (Ollama,

        mock) still exercises reachability. Returns ``{ok, provider, model, error}``

        rather than raising, so the UI renders a clean error state.'
      operationId: validate_provider_api_providers__provider_id__validate_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider_id
        in: path
        required: true
        schema:
          type: string
          title: Provider Id
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderValidationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
  /api/providers/{provider_id}/models:
    get:
      tags:
      - Providers
      summary: Get Provider Models
      description: 'Models the provider offers, listed live where it can.


        Uses the key and endpoint resolved for ``repo_id``. ``base_url`` tests an

        endpoint before it is saved (the "Test connection" button); the stored key

        is never sent to a URL it was not saved for. On any failure the built-in

        list comes back with ``source: "catalog"`` and ``error`` saying why.'
      operationId: get_provider_models_api_providers__provider_id__models_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider_id
        in: path
        required: true
        schema:
          type: string
          title: Provider Id
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      - name: base_url
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Base Url
      - name: refresh
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Refresh
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderModelsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
components:
  schemas:
    ActiveProviderSelection:
      properties:
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        base_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Base Url
        provenance:
          $ref: '#/components/schemas/SelectionProvenance'
          default: {}
        base_url_unconfirmed:
          type: boolean
          title: Base Url Unconfirmed
          default: false
        input_cost_per_1k:
          anyOf:
          - type: number
          - type: 'null'
          title: Input Cost Per 1K
        output_cost_per_1k:
          anyOf:
          - type: number
          - type: 'null'
          title: Output Cost Per 1K
        embedder:
          anyOf:
          - type: string
          - type: 'null'
          title: Embedder
      type: object
      title: ActiveProviderSelection
      description: The provider/model this scope resolves to; ``None`` when unset.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    EmbedderEntry:
      properties:
        id:
          type: string
          title: Id
        env_vars:
          items:
            type: string
          type: array
          title: Env Vars
          default: []
        semantic:
          type: boolean
          title: Semantic
          default: true
      type: object
      required:
      - id
      title: EmbedderEntry
      description: One registered embedder, as the settings picker renders it.
    SelectionProvenance:
      properties:
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        base_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Base Url
      type: object
      title: SelectionProvenance
    ProviderModelEntry:
      properties:
        id:
          type: string
          title: Id
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
      type: object
      required:
      - id
      title: ProviderModelEntry
    ProviderEntry:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        models:
          items:
            type: string
          type: array
          title: Models
          default: []
        default_model:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Model
        configured:
          type: boolean
          title: Configured
          default: false
        requires_key:
          type: boolean
          title: Requires Key
          default: true
        accepts_base_url:
          type: boolean
          title: Accepts Base Url
          default: false
        local_server:
          type: boolean
          title: Local Server
          default: false
        local_model:
          type: boolean
          title: Local Model
          default: false
        env_vars:
          items:
            type: string
          type: array
          title: Env Vars
          default: []
        setup_hint:
          type: string
          title: Setup Hint
          default: ''
        detected:
          anyOf:
          - type: string
            enum:
            - signed_in
            - env
            - saved
          - type: 'null'
          title: Detected
      type: object
      required:
      - id
      - name
      title: ProviderEntry
      description: One provider in the catalog, as the settings picker renders it.
    ProviderModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/ProviderModelEntry'
          type: array
          title: Models
        source:
          type: string
          enum:
          - live
          - catalog
          title: Source
        default_model:
          type: string
          title: Default Model
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - models
      - source
      - default_model
      title: ProviderModelsResponse
      description: 'Models a provider offers, newest-looking first after the default.


        ``source`` is ``live`` when the provider listed them and ``catalog`` when

        the built-in list stands in, with ``error`` saying why.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SetApiKeyRequest:
      properties:
        api_key:
          type: string
          title: Api Key
        repo_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      type: object
      required:
      - api_key
      title: SetApiKeyRequest
    ProviderStatusResponse:
      properties:
        active:
          $ref: '#/components/schemas/ActiveProviderSelection'
        providers:
          items:
            $ref: '#/components/schemas/ProviderEntry'
          type: array
          title: Providers
          default: []
        flag_only_providers:
          items:
            type: string
          type: array
          title: Flag Only Providers
          default: []
        embedders:
          items:
            $ref: '#/components/schemas/EmbedderEntry'
          type: array
          title: Embedders
          default: []
      type: object
      required:
      - active
      title: ProviderStatusResponse
    ProviderValidationResponse:
      properties:
        ok:
          type: boolean
          title: Ok
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - ok
      title: ProviderValidationResponse
      description: 'Outcome of the live single-provider smoke test.


        A failed probe reports ``ok=False`` with ``error`` set rather than raising,

        so the settings UI renders a clean error state.'
    SetActiveProviderRequest:
      properties:
        provider:
          type: string
          title: Provider
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        base_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Base Url
        repo_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      type: object
      required:
      - provider
      title: SetActiveProviderRequest
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization