openapi: 3.2.0
info:
  title: LiteLLM Vector Stores API
  description: 'Proxy Server to call 100+ LLMs in the OpenAI format. **Customize Swagger Docs**


    👉 ```LiteLLM Admin Panel on /ui```. Create, Edit Keys with SSO. Having issues? Try ```Fallback Login```


    💸 ```LiteLLM Model Cost Map```.


    🔎 ```LiteLLM Model Hub```. See available models on the proxy. **Docs**'
  version: 1.102.1
tags:
- name: Vector Stores
paths:
  /v1/indexes:
    get:
      description: 'List all vector store indexes. Proxy admin only.


        ```bash

        curl -L -X GET ''http://0.0.0.0:4000/v1/indexes'' -H ''Authorization: Bearer sk-1234''

        ```'
      operationId: index_list_v1_indexes_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexListResponse'
          description: Successful Response
      security:
      - APIKeyHeader: []
      summary: Index List
      tags:
      - Vector Stores
    post:
      description: 'Create an index. Just writes the index to the database.


        ```bash

        curl -L -X POST ''http://0.0.0.0:4000/v1/indexes'' -H ''Content-Type: application/json'' -H ''Authorization: Bearer sk-1234'' -d ''{

        "index_name": "dall-e-3",

        "litellm_params": {

        "vector_store_index": "real-index-name",

        "vector_store_name": "azure-ai-search"

        }

        }''

        ```'
      operationId: index_create_v1_indexes_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Index Create
      tags:
      - Vector Stores
  /v1/vector_stores:
    get:
      description: 'List vector stores.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/list'
      operationId: vector_store_list_v1_vector_stores_get
      parameters:
      - in: query
        name: after
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - in: query
        name: before
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Before
      - in: query
        name: limit
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          default: 20
          title: Limit
      - in: query
        name: order
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Order
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store List
      tags:
      - Vector Stores
    post:
      description: 'Create a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/create


        Supports target_model_names parameter for creating vector stores across multiple models:

        ```json

        {

        "name": "my-vector-store",

        "target_model_names": "gpt-4,gemini-2.0"

        }

        ```'
      operationId: vector_store_create_v1_vector_stores_post
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
      security:
      - APIKeyHeader: []
      summary: Vector Store Create
      tags:
      - Vector Stores
  /v1/vector_stores/{vector_store_id}:
    delete:
      description: 'Delete a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/delete'
      operationId: vector_store_delete_v1_vector_stores__vector_store_id__delete
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Delete
      tags:
      - Vector Stores
    get:
      description: 'Retrieve a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/retrieve'
      operationId: vector_store_retrieve_v1_vector_stores__vector_store_id__get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Retrieve
      tags:
      - Vector Stores
    post:
      description: 'Update a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/modify'
      operationId: vector_store_update_v1_vector_stores__vector_store_id__post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Update
      tags:
      - Vector Stores
  /v1/vector_stores/{vector_store_id}/files:
    get:
      operationId: vector_store_file_list_v1_vector_stores__vector_store_id__files_get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File List
      tags:
      - Vector Stores
    post:
      operationId: vector_store_file_create_v1_vector_stores__vector_store_id__files_post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Create
      tags:
      - Vector Stores
  /v1/vector_stores/{vector_store_id}/files/{file_id}:
    delete:
      operationId: vector_store_file_delete_v1_vector_stores__vector_store_id__files__file_id__delete
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Delete
      tags:
      - Vector Stores
    get:
      operationId: vector_store_file_retrieve_v1_vector_stores__vector_store_id__files__file_id__get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Retrieve
      tags:
      - Vector Stores
    post:
      operationId: vector_store_file_update_v1_vector_stores__vector_store_id__files__file_id__post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Update
      tags:
      - Vector Stores
  /v1/vector_stores/{vector_store_id}/files/{file_id}/content:
    get:
      operationId: vector_store_file_content_v1_vector_stores__vector_store_id__files__file_id__content_get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Content
      tags:
      - Vector Stores
  /v1/vector_stores/{vector_store_id}/search:
    post:
      description: 'Search a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/search'
      operationId: vector_store_search_v1_vector_stores__vector_store_id__search_post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Search
      tags:
      - Vector Stores
  /vector_stores:
    get:
      description: 'List vector stores.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/list'
      operationId: vector_store_list_vector_stores_get
      parameters:
      - in: query
        name: after
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - in: query
        name: before
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Before
      - in: query
        name: limit
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          default: 20
          title: Limit
      - in: query
        name: order
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: desc
          title: Order
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store List
      tags:
      - Vector Stores
    post:
      description: 'Create a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/create


        Supports target_model_names parameter for creating vector stores across multiple models:

        ```json

        {

        "name": "my-vector-store",

        "target_model_names": "gpt-4,gemini-2.0"

        }

        ```'
      operationId: vector_store_create_vector_stores_post
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
      security:
      - APIKeyHeader: []
      summary: Vector Store Create
      tags:
      - Vector Stores
  /vector_stores/{vector_store_id}:
    delete:
      description: 'Delete a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/delete'
      operationId: vector_store_delete_vector_stores__vector_store_id__delete
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Delete
      tags:
      - Vector Stores
    get:
      description: 'Retrieve a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/retrieve'
      operationId: vector_store_retrieve_vector_stores__vector_store_id__get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Retrieve
      tags:
      - Vector Stores
    post:
      description: 'Update a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/modify'
      operationId: vector_store_update_vector_stores__vector_store_id__post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Update
      tags:
      - Vector Stores
  /vector_stores/{vector_store_id}/files:
    get:
      operationId: vector_store_file_list_vector_stores__vector_store_id__files_get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File List
      tags:
      - Vector Stores
    post:
      operationId: vector_store_file_create_vector_stores__vector_store_id__files_post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Create
      tags:
      - Vector Stores
  /vector_stores/{vector_store_id}/files/{file_id}:
    delete:
      operationId: vector_store_file_delete_vector_stores__vector_store_id__files__file_id__delete
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Delete
      tags:
      - Vector Stores
    get:
      operationId: vector_store_file_retrieve_vector_stores__vector_store_id__files__file_id__get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Retrieve
      tags:
      - Vector Stores
    post:
      operationId: vector_store_file_update_vector_stores__vector_store_id__files__file_id__post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Update
      tags:
      - Vector Stores
  /vector_stores/{vector_store_id}/files/{file_id}/content:
    get:
      operationId: vector_store_file_content_vector_stores__vector_store_id__files__file_id__content_get
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          title: File Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store File Content
      tags:
      - Vector Stores
  /vector_stores/{vector_store_id}/search:
    post:
      description: 'Search a vector store.


        API Reference:

        https://platform.openai.com/docs/api-reference/vector-stores/search'
      operationId: vector_store_search_vector_stores__vector_store_id__search_post
      parameters:
      - in: path
        name: vector_store_id
        required: true
        schema:
          title: Vector Store Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - APIKeyHeader: []
      summary: Vector Store Search
      tags:
      - Vector Stores
components:
  schemas:
    IndexCreateLiteLLMParams:
      properties:
        vector_store_index:
          title: Vector Store Index
          type: string
        vector_store_name:
          title: Vector Store Name
          type: string
      required:
      - vector_store_index
      - vector_store_name
      title: IndexCreateLiteLLMParams
      type: object
    IndexCreateRequest:
      properties:
        index_info:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Index Info
        index_name:
          title: Index Name
          type: string
        litellm_params:
          $ref: '#/components/schemas/IndexCreateLiteLLMParams'
      required:
      - index_name
      - litellm_params
      title: IndexCreateRequest
      type: object
    LiteLLM_ManagedVectorStoreIndex:
      description: LiteLLM managed vector store index object - this is is the object stored in the database
      properties:
        created_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Created At
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
        id:
          title: Id
          type: string
        index_info:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Index Info
        index_name:
          title: Index Name
          type: string
        litellm_params:
          $ref: '#/components/schemas/IndexCreateLiteLLMParams'
        updated_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Updated At
        updated_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated By
      required:
      - id
      - index_name
      - litellm_params
      title: LiteLLM_ManagedVectorStoreIndex
      type: object
    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
    IndexListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/LiteLLM_ManagedVectorStoreIndex'
          title: Data
          type: array
        object:
          const: list
          default: list
          title: Object
          type: string
      required:
      - data
      title: IndexListResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Bearer token
      in: header
      name: x-litellm-api-key