Skip to main content
GET
Read file or get metadata

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from the console.

Path Parameters

path
string
required

File path (S3-style, no leading slash)

Query Parameters

version
integer

Specific version to read

Required range: x >= 1
metadata
enum<string>

Get file metadata instead of content

Available options:
versions
enum<string>

List all versions of the file

Available options:
limit
integer
default:10

Limit for versions listing

Required range: 1 <= x <= 100
offset
integer
default:0

Offset for versions listing

Required range: x >= 0

Response

Success

success
boolean
required
Example:

true

data
object
required
operation
string
required
Example:

"read_file"

message
string
required
Example:

"File read successfully"