Claude Platform Docs

Files

Upload File
beta.files.upload(FileUploadParams**kwargs) -> BetaFileMetadata
POST/v1/files
List Files
beta.files.list(FileListParams**kwargs) -> SyncPage[BetaFileMetadata]
GET/v1/files
Download File
beta.files.download(strfile_id, FileDownloadParams**kwargs) -> BinaryResponseContent
GET/v1/files/{file_id}/content
Get File Metadata
beta.files.retrieve_metadata(strfile_id, FileRetrieveMetadataParams**kwargs) -> BetaFileMetadata
GET/v1/files/{file_id}
Delete File
beta.files.delete(strfile_id, FileDeleteParams**kwargs) -> BetaDeletedFile
DELETE/v1/files/{file_id}
Models
class BetaDeletedFile: …
id: str

ID of the deleted file.

type: Optional[Literal["file_deleted"]]

Deleted object type.

For file deletion, this is always "file_deleted".

defaultfile_deleted
class BetaFileMetadata: …
id: str

Unique object identifier.

The format and length of IDs may change over time.

created_at: datetime

RFC 3339 datetime string representing when the file was created.

formatdate-time
filename: str

Original filename of the uploaded file.

maxLength500
minLength1
mime_type: str

MIME type of the file.

maxLength255
minLength1
size_bytes: int

Size of the file in bytes.

minimum0
type: Literal["file"]

Object type.

For files, this is always "file".

downloadable: Optional[bool]

Whether the file can be downloaded.

defaultfalse
scope: Optional[BetaFileScope]

The scope of this file, indicating the context in which it was created (e.g., a session).

id: str

The ID of the scoping resource (e.g., the session ID).

type: Literal["session"]

The type of scope (e.g., "session").

class BetaFileScope: …
id: str

The ID of the scoping resource (e.g., the session ID).

type: Literal["session"]

The type of scope (e.g., "session").