Files

Upload File

client.Files.Upload(ctx, body) (*FileMetadata, error)

POST/v1/files

List Files

client.Files.List(ctx, query) (*PageCursor[FileMetadata], error)

GET/v1/files

Download File

client.Files.Download(ctx, fileID) (*Response, error)

GET/v1/files/{file_id}/content

Get File Metadata

client.Files.GetMetadata(ctx, fileID) (*FileMetadata, error)

GET/v1/files/{file_id}

Delete File

client.Files.Delete(ctx, fileID) (*DeletedFile, error)

DELETE/v1/files/{file_id}

Models

type DeletedFile struct{…}

ID string

ID of the deleted file.

Type DeletedFileType Optional

Deleted object type.

For file deletion, this is always "file_deleted".

defaultfile_deleted

type FileMetadata struct{…}

ID string

Unique object identifier.

The format and length of IDs may change over time.

CreatedAt Time

RFC 3339 datetime string representing when the file was created.

formatdate-time

Filename string

Original filename of the uploaded file.

maxLength500

minLength1

MimeType string

MIME type of the file.

maxLength255

minLength1

SizeBytes int64

Size of the file in bytes.

minimum0

Type File

Object type.

For files, this is always "file".

Downloadable bool Optional

Whether the file can be downloaded.

defaultfalse

ExpiresAt Time Optional

RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with expires_in_seconds, this is the upload time plus that value.

formatdate-time