Poolside models API

The models API from Poolside — 1 operation(s) for models.

OpenAPI Specification

poolside-ai-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: OpenAI Compatible chat models API
  version: 1.0.0
tags:
- name: models
paths:
  /openai/v1/models:
    get:
      operationId: list-models
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageListModel'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
      - bearerAuth: []
      summary: List models
      tags:
      - models
components:
  schemas:
    Model:
      additionalProperties: true
      properties:
        created:
          description: The Unix timestamp (in seconds) when the model was created.
          format: int64
          type: integer
        id:
          description: The model identifier.
          type: string
        object:
          enum:
          - model
          type: string
        owned_by:
          enum:
          - system
          type: string
      required:
      - id
      - created
      - owned_by
      - object
      type: object
    ErrorDetail:
      additionalProperties: true
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ErrorModel:
      additionalProperties: true
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/openai/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    PageListModel:
      additionalProperties: true
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/openai/schemas/PageListModel.json
          format: uri
          readOnly: true
          type: string
        data:
          items:
            $ref: '#/components/schemas/Model'
          type: array
        object:
          type: string
      required:
      - data
      - object
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http