openapi: 3.2.0
info:
  title: xAI's REST Embedding Models API
  description: REST API for xAI compatible with other providers.
  license:
    name: ''
  version: 1.0.0
tags:
- name: Embedding Models
paths:
  /v1/embedding-models:
    get:
      tags:
      - Embedding Models
      summary: List all embedding models available to the authenticating API key with full…
      operationId: handle_embedding_models_list_request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmbeddingModelsResponse'
              example:
                models:
                - id: v1
                  fingerprint: fp_df37966059
                  created: 1725148800
                  object: model
                  owned_by: xai
                  version: 0.1.0
                  input_modalities:
                  - text
                  prompt_text_token_price: 100
                  prompt_image_token_price: 0
                  aliases: []
        '400':
          description: Bad request. The request is invalid or an invalid API key is provided.
      security:
      - bearerAuth: []
  /v1/embedding-models/{model_id}:
    get:
      tags:
      - Embedding Models
      summary: Get full information about an embedding model with its model_id
      operationId: handle_embedding_model_get_request
      parameters:
      - name: model_id
        in: path
        description: ID of the model to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingModel'
              example:
                id: v1
                created: 1725148800
                object: model
                owned_by: xai
                version: 0.1.0
                input_modalities:
                - text
                prompt_text_token_price: 10
                prompt_image_token_price: 0
                aliases: []
        '400':
          description: Bad request. The request is invalid or an invalid API key is provided.
        '404':
          description: Model not found
      security:
      - bearerAuth: []
components:
  schemas:
    EmbeddingModel:
      type: object
      description: Details of an embedding model
      required:
      - id
      - fingerprint
      - created
      - object
      - owned_by
      - version
      - input_modalities
      - output_modalities
      - prompt_text_token_price
      - prompt_image_token_price
      - aliases
      properties:
        aliases:
          type: array
          items:
            type: string
          description: Alias ID(s) of the model that user can use in a request's model field.
        created:
          type: integer
          format: int64
          description: Model creation time in Unix timestamp.
        fingerprint:
          type: string
          description: Fingerprint of the xAI system configuration hosting the model.
        id:
          type: string
          description: Model ID. Obtainable from <https://console.x.ai/team/default/models> or <https://docs.x.ai/docs/models>.
        input_modalities:
          type: array
          items:
            type: string
          description: The input modalities supported by the model.
        object:
          type: string
          description: Object type, should be model.
        output_modalities:
          type: array
          items:
            type: string
          description: The output modalities supported by the model.
        owned_by:
          type: string
          description: Owner of the model.
        prompt_image_token_price:
          type: integer
          format: int64
          description: Price of the prompt image token in USD cents per million token.
        prompt_text_token_price:
          type: integer
          format: int64
          description: Price of the prompt text token in USD cents per million token.
        version:
          type: string
          description: Version of the model.
    ListEmbeddingModelsResponse:
      type: object
      required:
      - models
      properties:
        models:
          type: array
          items:
            $ref: '#/components/schemas/EmbeddingModel'
          description: Array of available embedding models.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer