README.md

Files

(files)

Overview

Files API

Available Operations

• upload - Upload File
• list - List Files
• retrieve - Retrieve File
• delete - Delete File

upload

Upload a file that can be used across various endpoints.

The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files.

Please contact us if you need to increase these storage limits.

Example Usage

from beezy_ai import BeezyAI
import os

s = BeezyAI(
    api_key_auth=os.getenv("API_KEY_AUTH", ""),
)


res = s.files.upload(purpose="fine-tune", file={
    "file_name": "your_file_here",
    "content": open("<file_path>", "rb"),
})

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description	Example
purpose	str	✔️	The intended purpose of the uploaded file. Only accepts fine-tuning (fine-tune) for now.	fine-tune
file	models.File	✔️	The File object (not file name) to be uploaded.

Response

models.UploadFileOut

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

list

Returns a list of files that belong to the user's organization.

Example Usage

from beezy_ai import BeezyAI
import os

s = BeezyAI(
    api_key_auth=os.getenv("API_KEY_AUTH", ""),
)


res = s.files.list()

if res is not None:
    # handle response
    pass

Response

models.ListFilesOut

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

retrieve

Returns information about a specific file.

Example Usage

from beezy_ai import BeezyAI
import os

s = BeezyAI(
    api_key_auth=os.getenv("API_KEY_AUTH", ""),
)


res = s.files.retrieve(file_id="<value>")

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
file_id	str	✔️	N/A

Response

models.RetrieveFileOut

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/

delete

Delete a file.

Example Usage

from beezy_ai import BeezyAI
import os

s = BeezyAI(
    api_key_auth=os.getenv("API_KEY_AUTH", ""),
)


res = s.files.delete(file_id="<value>")

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
file_id	str	✔️	N/A

Response

models.DeleteFileOut

Errors

Error Object	Status Code	Content Type
models.SDKError	4xx-5xx	/