Skip to main content

Overview

Files endpoints

Available Operations

List

Lists files belonging to the workspace of the authenticating API key.

Example Usage

Parameters

Response

*operations.ListFilesResponse, error

Errors

Upload

Uploads a file to be referenced in future API calls. The file is stored under the workspace of the authenticating API key. Maximum file size: 100 MB.

Example Usage

Parameters

Response

*components.FileMetadata, error

Errors

Delete

Deletes a file owned by the requesting workspace. Deletion is irreversible.

Example Usage

Parameters

Response

*components.FileDeleteResponse, error

Errors

Retrieve

Retrieves metadata for a single file owned by the requesting workspace.

Example Usage

Parameters

Response

*components.FileMetadata, error

Errors

Download

Downloads the raw bytes of a file. Only files created server-side are downloadable; uploaded files return 400.

Example Usage

Parameters

Response

io.ReadCloser, error

Errors