Files

Upload File

beta.files.upload(**kwargs) -> FileMetadata { id, created_at, filename, 4 more }

POST/v1/files

List Files

beta.files.list(**kwargs) -> Page<FileMetadata { id, created_at, filename, 4 more } >

GET/v1/files

Download File

beta.files.download(file_id, **kwargs) -> StringIO

GET/v1/files/{file_id}/content

Get File Metadata

beta.files.retrieve_metadata(file_id, **kwargs) -> FileMetadata { id, created_at, filename, 4 more }

GET/v1/files/{file_id}

Delete File

beta.files.delete(file_id, **kwargs) -> DeletedFile { id, type }

DELETE/v1/files/{file_id}

ModelsExpand Collapse

class DeletedFile { id, type }

id: String

ID of the deleted file.

type: :file_deleted

Deleted object type.

For file deletion, this is always "file_deleted".

class FileMetadata { id, created_at, filename, 4 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

created_at: Time

RFC 3339 datetime string representing when the file was created.

filename: String

Original filename of the uploaded file.

mime_type: String

MIME type of the file.

size_bytes: Integer

Size of the file in bytes.

type: :file

Object type.

For files, this is always "file".

downloadable: bool

Whether the file can be downloaded.

Files

Upload File

beta.files.upload(**kwargs) -> FileMetadata { id, created_at, filename, 4 more }

POST/v1/files

List Files

beta.files.list(**kwargs) -> Page<FileMetadata { id, created_at, filename, 4 more } >

GET/v1/files

Download File

beta.files.download(file_id, **kwargs) -> StringIO

GET/v1/files/{file_id}/content

Get File Metadata

beta.files.retrieve_metadata(file_id, **kwargs) -> FileMetadata { id, created_at, filename, 4 more }

GET/v1/files/{file_id}

Delete File

beta.files.delete(file_id, **kwargs) -> DeletedFile { id, type }

DELETE/v1/files/{file_id}

ModelsExpand Collapse

class DeletedFile { id, type }

id: String

ID of the deleted file.

type: :file_deleted

Deleted object type.

For file deletion, this is always "file_deleted".

class FileMetadata { id, created_at, filename, 4 more }

id: String

Unique object identifier.

The format and length of IDs may change over time.

created_at: Time

RFC 3339 datetime string representing when the file was created.

filename: String

Original filename of the uploaded file.

mime_type: String

MIME type of the file.

size_bytes: Integer

Size of the file in bytes.

type: :file

Object type.

For files, this is always "file".

downloadable: bool

Whether the file can be downloaded.