Skip to main content
Upload a file
curl --request POST \
  --url https://sapi.withsutro.com/storage/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-sutro-api-client: <api-key>' \
  --form file='@example-file' \
  --form customerId=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form builderId=3c90c3cc-0d44-4b50-8888-8dd25736052a
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "size": 123,
  "mimeType": "<string>",
  "bucket": "<string>",
  "path": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "builderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Builder authentication and authorization

​
x-sutro-api-client
string
header
required

A unique identifier for the API Client making a request

Body

multipart/form-data
​
file
file
required

The file to upload

​
customerId
string<uuid>
required

The ID of the customer uploading the file

​
builderId
string<uuid>

Optional builder ID to associate with the file

Response

File uploaded successfully

A file stored in object storage with metadata and timestamps

​
id
string<uuid>
required

Unique identifier for the stored object

​
name
string
required

The original file name

​
size
integer
required

File size in bytes

​
mimeType
string
required

MIME type of the file

​
bucket
string
required

The storage bucket name

​
path
string
required

The full path in object storage

​
customerId
string<uuid>
required

The ID of the customer who owns this file

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
builderId
string<uuid> | null

The ID of the builder associated with this file, if any

​
deletedAt
string<date-time> | null