openapi: 3.2.0
info:
  title: LiteLLM Files 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: Files
paths:
  /files:
    post:
      tags:
      - Files
      summary: Create File
      description: 'Upload a file that can be used across - Assistants API, Batch API

        This is the equivalent of POST https://api.openai.com/v1/files


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"

        -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000

        ```'
      operationId: create_file_files_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_file_files_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Files
      summary: List Files
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"


        ```'
      operationId: list_files_files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      - name: target_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Model Names
      - name: purpose
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/files:
    post:
      tags:
      - Files
      summary: Create File
      description: 'Upload a file that can be used across - Assistants API, Batch API

        This is the equivalent of POST https://api.openai.com/v1/files


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"

        -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000

        ```'
      operationId: create_file_v1_files_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_file_v1_files_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Files
      summary: List Files
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"


        ```'
      operationId: list_files_v1_files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      - name: target_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Model Names
      - name: purpose
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /{provider}/v1/files:
    post:
      tags:
      - Files
      summary: Create File
      description: 'Upload a file that can be used across - Assistants API, Batch API

        This is the equivalent of POST https://api.openai.com/v1/files


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"

        -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000

        ```'
      operationId: create_file__provider__v1_files_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_file__provider__v1_files_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Files
      summary: List Files
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list


        Example Curl

        ```

        curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"


        ```'
      operationId: list_files__provider__v1_files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: provider
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      - name: target_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Model Names
      - name: purpose
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Limit
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /files/{file_id}/content:
    get:
      tags:
      - Files
      summary: Get File Content
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file_content_files__file_id__content_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/files/{file_id}/content:
    get:
      tags:
      - Files
      summary: Get File Content
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file_content_v1_files__file_id__content_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /{provider}/v1/files/{file_id}/content:
    get:
      tags:
      - Files
      summary: Get File Content
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file_content__provider__v1_files__file_id__content_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /files/{file_id}:
    get:
      tags:
      - Files
      summary: Get File
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file_files__file_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Files
      summary: Delete File
      description: 'Deletes a specified file. that can be used across - Assistants API, Batch API

        This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"


        ```'
      operationId: delete_file_files__file_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/files/{file_id}:
    get:
      tags:
      - Files
      summary: Get File
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file_v1_files__file_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Files
      summary: Delete File
      description: 'Deletes a specified file. that can be used across - Assistants API, Batch API

        This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"


        ```'
      operationId: delete_file_v1_files__file_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /{provider}/v1/files/{file_id}:
    get:
      tags:
      - Files
      summary: Get File
      description: 'Returns information about a specific file. that can be used across - Assistants API, Batch API

        This is the equivalent of GET https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"


        ```'
      operationId: get_file__provider__v1_files__file_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Files
      summary: Delete File
      description: 'Deletes a specified file. that can be used across - Assistants API, Batch API

        This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}


        Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete


        Example Curl

        ```

        curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"


        ```'
      operationId: delete_file__provider__v1_files__file_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      - name: provider
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_create_file_v1_files_post:
      properties:
        purpose:
          type: string
          title: Purpose
        target_model_names:
          type: string
          title: Target Model Names
          default: ''
        target_storage:
          type: string
          title: Target Storage
          default: default
        custom_llm_provider:
          type: string
          title: Custom Llm Provider
          default: openai
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        litellm_metadata:
          anyOf:
          - type: string
          - type: 'null'
          title: Litellm Metadata
      type: object
      required:
      - purpose
      - file
      title: Body_create_file_v1_files_post
    Body_create_file__provider__v1_files_post:
      properties:
        purpose:
          type: string
          title: Purpose
        target_model_names:
          type: string
          title: Target Model Names
          default: ''
        target_storage:
          type: string
          title: Target Storage
          default: default
        custom_llm_provider:
          type: string
          title: Custom Llm Provider
          default: openai
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        litellm_metadata:
          anyOf:
          - type: string
          - type: 'null'
          title: Litellm Metadata
      type: object
      required:
      - purpose
      - file
      title: Body_create_file__provider__v1_files_post
    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
    Body_create_file_files_post:
      properties:
        purpose:
          type: string
          title: Purpose
        target_model_names:
          type: string
          title: Target Model Names
          default: ''
        target_storage:
          type: string
          title: Target Storage
          default: default
        custom_llm_provider:
          type: string
          title: Custom Llm Provider
          default: openai
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        litellm_metadata:
          anyOf:
          - type: string
          - type: 'null'
          title: Litellm Metadata
      type: object
      required:
      - purpose
      - file
      title: Body_create_file_files_post
    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