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

> ## Agent Instructions
> To set Ambral up in a project, run `npx ambral@latest skill install` in the project's root. It installs Ambral's skill, matched to the CLI's version, and the skill says how to do everything these pages describe with the `ambral` CLI. Prefer it to working from these pages. Never ask anyone for an Ambral API key, and never handle one: the person creates it in the web app and stores it where their app reads its secrets.

# List models

> Lists `ambral/auto`, the model every request names, in the shape OpenAI's SDKs and model pickers read.



## OpenAPI

````yaml /api-reference/gateway.json get /v1/models
openapi: 3.1.0
info:
  title: Ambral Gateway API
  version: '1'
servers:
  - url: https://api.ambral.ai
security: []
tags:
  - name: inference
    description: OpenAI's Chat Completions API, and the models it lists
  - name: messages
    description: Anthropic's Messages API
paths:
  /v1/models:
    get:
      tags:
        - inference
      summary: List models
      description: >-
        Lists `ambral/auto`, the model every request names, in the shape
        OpenAI's SDKs and model pickers read.
      operationId: inference.models
      parameters: []
      responses:
        '200':
          description: >-
            The models the key can name, as OpenAI's SDKs and model pickers read
            a list of models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionsModelList'
        '401':
          description: >-
            No inference key, or one that is unknown or revoked, or whose org
            isn't active.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionsErrorBody'
        '503':
          description: >-
            The key, or the route of the workload the request names, couldn't be
            read. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionsErrorBody'
      security:
        - bearer: []
components:
  schemas:
    ChatCompletionsModelList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/ChatCompletionsModel'
      required:
        - object
        - data
      additionalProperties: false
      description: >-
        The models the key can name, as OpenAI's SDKs and model pickers read a
        list of models.
    ChatCompletionsErrorBody:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ChatCompletionsErrorDetail'
      required:
        - error
      additionalProperties: false
    ChatCompletionsModel:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ModelName'
        object:
          type: string
          enum:
            - model
        created:
          $ref: '#/components/schemas/EpochSeconds'
        owned_by:
          $ref: '#/components/schemas/ChatCompletionsModelOwner'
      required:
        - id
        - object
        - created
        - owned_by
      additionalProperties: false
    ChatCompletionsErrorDetail:
      type: object
      properties:
        message:
          type: string
        type:
          $ref: '#/components/schemas/ChatCompletionsErrorType'
        code:
          $ref: '#/components/schemas/ChatCompletionsErrorCode'
      required:
        - message
        - type
        - code
      additionalProperties: false
    ModelName:
      type: string
      minLength: 1
      maxLength: 256
    EpochSeconds:
      type: integer
      minimum: 0
      maximum: 9007199254740991
    ChatCompletionsModelOwner:
      type: string
    ChatCompletionsErrorType:
      type: string
    ChatCompletionsErrorCode:
      type: string
  securitySchemes:
    bearer:
      description: An inference key, made on the API keys page of Ambral's app.
      type: http
      scheme: Bearer

````

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