openapi: 3.2.0
info:
  title: LiteLLM Containers 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: Containers
paths:
  /containers:
    post:
      tags:
      - Containers
      summary: Create Container
      description: 'Container creation endpoint for creating new containers.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d ''{

        "name": "My Container",

        "expires_after": {

        "anchor": "last_active_at",

        "minutes": 20

        }

        }''

        ```


        Or specify provider via header:

        ```bash

        curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure" -H "Content-Type: application/json" -d ''{

        "name": "My Container"

        }''

        ```'
      operationId: create_container_containers_post
      security:
      - APIKeyHeader: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    get:
      tags:
      - Containers
      summary: List Containers
      description: 'Container list endpoint for retrieving a list of containers.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers?limit=20&order=desc" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header or query param:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers?custom_llm_provider=azure" -H "Authorization: Bearer sk-1234"

        ```'
      operationId: list_containers_containers_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Order
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/containers:
    post:
      tags:
      - Containers
      summary: Create Container
      description: 'Container creation endpoint for creating new containers.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d ''{

        "name": "My Container",

        "expires_after": {

        "anchor": "last_active_at",

        "minutes": 20

        }

        }''

        ```


        Or specify provider via header:

        ```bash

        curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure" -H "Content-Type: application/json" -d ''{

        "name": "My Container"

        }''

        ```'
      operationId: create_container_v1_containers_post
      security:
      - APIKeyHeader: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    get:
      tags:
      - Containers
      summary: List Containers
      description: 'Container list endpoint for retrieving a list of containers.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers?limit=20&order=desc" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header or query param:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers?custom_llm_provider=azure" -H "Authorization: Bearer sk-1234"

        ```'
      operationId: list_containers_v1_containers_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: order
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Order
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /containers/{container_id}:
    get:
      tags:
      - Containers
      summary: Retrieve Container
      description: 'Container retrieve endpoint for getting details of a specific container.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"

        ```'
      operationId: retrieve_container_containers__container_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Containers
      summary: Delete Container
      description: 'Container delete endpoint for deleting a specific container.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header:

        ```bash

        curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"

        ```'
      operationId: delete_container_containers__container_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/containers/{container_id}:
    get:
      tags:
      - Containers
      summary: Retrieve Container
      description: 'Container retrieve endpoint for getting details of a specific container.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header:

        ```bash

        curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"

        ```'
      operationId: retrieve_container_v1_containers__container_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Containers
      summary: Delete Container
      description: 'Container delete endpoint for deleting a specific container.


        Follows the OpenAI Containers API spec:

        https://platform.openai.com/docs/api-reference/containers


        Example:

        ```bash

        curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"

        ```


        Or specify provider via header:

        ```bash

        curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"

        ```'
      operationId: delete_container_v1_containers__container_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/containers/{container_id}/files:
    get:
      tags:
      - Containers
      summary: Handler Container Id
      operationId: handler_container_id_v1_containers__container_id__files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Containers
      summary: Handler Multipart Upload
      operationId: handler_multipart_upload_v1_containers__container_id__files_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /containers/{container_id}/files:
    get:
      tags:
      - Containers
      summary: Handler Container Id
      operationId: handler_container_id_containers__container_id__files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Containers
      summary: Handler Multipart Upload
      operationId: handler_multipart_upload_containers__container_id__files_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/containers/{container_id}/files/{file_id}:
    get:
      tags:
      - Containers
      summary: Handler Container File
      operationId: handler_container_file_v1_containers__container_id__files__file_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Containers
      summary: Handler Container File
      operationId: handler_container_file_v1_containers__container_id__files__file_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /containers/{container_id}/files/{file_id}:
    get:
      tags:
      - Containers
      summary: Handler Container File
      operationId: handler_container_file_containers__container_id__files__file_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Containers
      summary: Handler Container File
      operationId: handler_container_file_containers__container_id__files__file_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/containers/{container_id}/files/{file_id}/content:
    get:
      tags:
      - Containers
      summary: Handler Binary Content
      operationId: handler_binary_content_v1_containers__container_id__files__file_id__content_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /containers/{container_id}/files/{file_id}/content:
    get:
      tags:
      - Containers
      summary: Handler Binary Content
      operationId: handler_binary_content_containers__container_id__files__file_id__content_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: container_id
        in: path
        required: true
        schema:
          type: string
          title: Container Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    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