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

# List configured models

> List text, vision, and OCR models configured for this tenant's environment from the workspace model catalog. This is a cheap read-only inventory: it does not call providers. `health` is `configured` or `unconfigured` from local credentials, never a live probe. Secrets and provider endpoints are never returned.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/models
openapi: 3.1.0
info:
  title: Eigenpal API
  version: 1.0.0
  description: >-
    Public REST API for inspecting automations, starting and monitoring runs,
    managing files, collecting human reviews, and running evaluations.
  contact:
    name: Eigenpal
    url: https://eigenpal.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: https://api.eigenpal.com
    description: Production (canonical API hostname)
security:
  - bearerAuth: []
tags:
  - name: Metadata
    description: Authenticate and inspect the current API context.
  - name: Models
    description: >-
      List text, vision, and OCR models configured for the current tenant
      environment. This is a catalog inventory, not a live provider health
      probe.
  - name: Automations
    description: >-
      Inspect runnable workflow and agent automations, their versions, triggers,
      and source sync state.
  - name: Runs
    description: >-
      Start, monitor, retry, review, and debug automation runs, including
      artifacts.
  - name: Reviews
    description: >-
      Record human review verdicts, manage corrected outputs, and monitor review
      health.
  - name: Files
    description: Upload reusable files for later run or dataset use.
  - name: Templates
    description: >-
      Upload, inspect, version, download, and delete tenant-scoped DOCX and XLSX
      templates.
  - name: Email servers
    description: >-
      Create and manage outbound email servers for workflow mail. Secrets are
      encrypted at rest and never returned.
  - name: Evaluation
    description: >-
      Manage datasets, examples, evaluators, experiment batches, evaluator
      scores, and run promotion workflows.
paths:
  /v1/models:
    get:
      tags:
        - Models
      summary: List configured models
      description: >-
        List text, vision, and OCR models configured for this tenant's
        environment from the workspace model catalog. This is a cheap read-only
        inventory: it does not call providers. `health` is `configured` or
        `unconfigured` from local credentials, never a live probe. Secrets and
        provider endpoints are never returned.
      operationId: models.list
      parameters:
        - in: query
          name: capability
          schema:
            description: >-
              Return only models that support this capability (`text`, `vision`,
              or `ocr`).
            type: string
            enum:
              - text
              - vision
              - ocr
          description: >-
            Return only models that support this capability (`text`, `vision`,
            or `ocr`).
      responses:
        '200':
          description: Configured models
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelsResponse'
        '400':
          description: Validation error. Request shape did not match the spec.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '403':
          description: API key lacks required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '413':
          description: Payload too large. Upload exceeded the per-request size cap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Seconds until the next request may succeed
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
components:
  schemas:
    ListModelsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicModel'
        total:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - data
        - total
      additionalProperties: false
    ApiErrorEnvelope:
      type: object
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorIssue'
        requestId:
          type: string
          description: Request id echoed via the x-request-id header
        hint:
          description: Suggested fix for known error patterns
          type: string
        docsUrl:
          description: Link to relevant docs
          type: string
        conflictingWorkflowId:
          description: >-
            Present on 409 workflow_name_conflict responses. Id of the workflow
            that already owns the requested name.
          type: string
      required:
        - issues
        - requestId
      additionalProperties: false
    PublicModel:
      type: object
      properties:
        id:
          type: string
        kind:
          type: string
          enum:
            - llm
            - ocr
        provider:
          type: string
        label:
          type: string
        capabilities:
          minItems: 1
          type: array
          items:
            type: string
            enum:
              - text
              - vision
              - ocr
        configured:
          type: boolean
        available:
          type: boolean
        health:
          type: string
          enum:
            - configured
            - unconfigured
            - unknown
          description: >-
            Configuration state only: `configured` means credentials are present
            in this environment; `unconfigured` means the catalog entry exists
            but credentials are missing. This list does not probe live
            providers, so it never reports healthy/degraded/outage. `unknown` is
            reserved and is not emitted by this endpoint.
        defaultFor:
          type: array
          items:
            type: string
            enum:
              - text
              - vision
              - ocr
        location:
          type: string
          enum:
            - local
            - hosted
          description: >-
            `local` means on-prem / no cloud provider egress (`local: true` or
            tesseract). `hosted` means the provider is a cloud API. Endpoints
            are never returned.
        limits:
          $ref: '#/components/schemas/PublicModelLimits'
        cost:
          $ref: '#/components/schemas/PublicModelCost'
          description: >-
            Static Eigenpal credit rates when known without a live vendor
            catalog. Omitted for OpenParser OCR and for LLMs (token prices are
            not part of this catalog).
        aliases:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        capabilityRank:
          description: >-
            Optional picker rank. Higher is more capable. Omitted on catalog
            rows that do not set it. Does not change role defaults.
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - id
        - kind
        - provider
        - label
        - capabilities
        - configured
        - available
        - health
        - defaultFor
        - location
        - aliases
        - tags
      additionalProperties: false
    ApiErrorIssue:
      type: object
      properties:
        field:
          type: string
          description: JSON path of the offending field, or "<root>"
        message:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: >-
            Machine-readable error code (e.g. invalid_value, not_found,
            api_trigger_disabled, manual_trigger_disabled)
        severity:
          type: string
          enum:
            - error
            - warning
          description: Issue severity
      required:
        - field
        - message
        - code
        - severity
      additionalProperties: false
    PublicModelLimits:
      type: object
      properties:
        requestTimeoutSeconds:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        maxConcurrentRequests:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
      additionalProperties: false
    PublicModelCost:
      type: object
      properties:
        creditsPerPage:
          type: number
          minimum: 0
        unit:
          type: string
          const: credits
      required:
        - unit
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued from Settings → API Keys. Pass as `Authorization: Bearer
        <key>`.

````