Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

multipart/form-data
file
file
required

The file to upload.

Maximum string length: 51200
type
enum<string>
required

The file type.

Available options:
form_image,
audio,
catalog,
certificate,
image,
other,
before_after
fileable_type
enum<string>
required

The fileable type (customer, user, tenant, chat_log, or ai_report).

Available options:
customer,
user,
tenant,
chat_log,
ai_report
fileable_id
integer
required

The fileable id.

Required range: x >= 1
description
string | null

The file description.

Maximum string length: 1000

Response

success
string
required
data
FileResource · object
required