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

# Get Available Models

> Models + effort levels this organisation can pick.

TrueState-included models are always available. Active BYO keys add models
for their provider. The browser remembers a member's last selection; this
endpoint supplies only a safe fallback.



## OpenAPI

````yaml https://api.truestate.io/openapi.json get /agents/models/
openapi: 3.1.0
info:
  title: TrueState Backend API
  summary: >-
    TrueState is an AI platform for business users to create high-impact AI
    solutions.
  description: >

    This **[TrueState](https://www.truestate.io/)** backend API allows our
    clients to automate and more powerfully retrieve and modify data from the
    TrueState platform.


    Example use cases include:


    - Accessing embeddings for a dataset.

    - Automating the process of dataset creation and model retraining as your
    data changes.

    - Much more.


    Our backend is built using the [FastAPI](https://fastapi.tiangolo.com/)
    framework in python

    using [Auth0](https://auth0.com/) and [Client API
    Keys](https://www.truestate.io/dawn/docs) for internal an external
    authentication, respectively.

    Our backend is designed to be secure, scalable, easy to use and well
    documented _(each router with its own linked docs page)_.

    Clients can only access data from their own organisation, as setup in Auth0
    our the Client API Keys. See how
    **[here](https://www.truestate.io/dawn/docs)**.


    **PS**: You can view this API documentation in either
    **[Swagger](swagger/docs)** or **[Redoc](redoc/)**, but only the swagger
    lets you test calls.
  contact:
    name: True State Support
    url: https://www.truestate.io/dawn/docs
    email: support@truestate.io
  license:
    name: Private
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 0.13.95
servers: []
security: []
paths:
  /agents/models/:
    get:
      tags:
        - agents
      summary: Get Available Models
      description: >-
        Models + effort levels this organisation can pick.


        TrueState-included models are always available. Active BYO keys add
        models

        for their provider. The browser remembers a member's last selection;
        this

        endpoint supplies only a safe fallback.
      operationId: get_available_models_agents_models__get
      parameters:
        - name: Api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelCatalog'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ModelCatalog:
      properties:
        models:
          items:
            $ref: '#/components/schemas/AvailableModel'
          type: array
          title: Models
        efforts:
          items:
            $ref: '#/components/schemas/EffortOption'
          type: array
          title: Efforts
        default_model:
          type: string
          title: Default Model
        default_effort:
          type: string
          title: Default Effort
      type: object
      required:
        - models
        - efforts
        - default_model
        - default_effort
      title: ModelCatalog
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AvailableModel:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        provider:
          type: string
          title: Provider
        is_default:
          type: boolean
          title: Is Default
        is_available:
          type: boolean
          title: Is Available
          default: true
        unlock_action:
          anyOf:
            - type: string
            - type: 'null'
          title: Unlock Action
      type: object
      required:
        - value
        - label
        - provider
        - is_default
      title: AvailableModel
    EffortOption:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        is_default:
          type: boolean
          title: Is Default
        is_available:
          type: boolean
          title: Is Available
          default: true
        unlock_action:
          anyOf:
            - type: string
            - type: 'null'
          title: Unlock Action
      type: object
      required:
        - value
        - label
        - is_default
      title: EffortOption
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````