Skip to main content

Files

Complete reference for file upload methods and models.

Methods​

upload_file​

upload_file(
    file_path: str,
    file_type: UploadFileType
) -> UploadFileResponse

Upload a file from local disk.

Parameters:

  • file_path - Path to file
  • file_type - File type (Image, Video, Pdf, File)

Returns: UploadFileResponse with uploaded file info

upload_file_from_url​

upload_file_from_url(
    file_url: str,
    file_type: UploadFileType = None,
    filename: str = None
) -> UploadFileResponse

Upload a file from URL.

Parameters:

  • file_url - URL of file to download
  • file_type - Optional file type (auto-detected if not provided)
  • filename - Optional custom filename

Returns: UploadFileResponse with uploaded file info

Models​

UploadedFile​

Main uploaded file model.

class UploadedFile:
    id: str                             # File ID
    url: str                            # Access URL
    name: str                           # Filename
    original_name: str                  # Original filename
    size: int                           # Size in bytes
    type: UploadFileType               # File type
    ext: str                            # Extension
    dimension: Optional[dict]           # Dimensions (images/videos)

TaskFile​

class TaskFile:
    id: str                             # File ID
    url: str                            # File URL
    name: str                           # Filename
    ext: str                            # File extension
    type: UploadFileType               # File type
    dimension: Optional[List[int]]      # Dimensions [width, height] for images/videos
    size: Optional[int]                 # File size in bytes

TaskUploadFile​

class TaskUploadFile:
    path: str                           # Path to file
    type: Optional[UploadFileType]     # File type (auto-detected if not provided)

Response Models​

UploadFileResponse​

class UploadFileResponse:
    type: str                           # Response type
    payload: UploadFilePayload          # Response payload
    
    @property
    def file(self) -> UploadedFile:    # Convenience property
        ...

UploadFilePayload​

class UploadFilePayload:
    file: UploadedFile                 # Uploaded file object

See Also​