Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Body

multipart/form-data
file
file
required

The file to be uploaded.

site_id
string

The ID of the site the file will belong to. Provide exactly one of site_id or site_external_id.

Example:

"ste_01k8g7aec6dt5zrtamc72ww446"

site_external_id
string

The external ID you assigned to the site the file will belong to. Provide exactly one of site_id or site_external_id.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9\-_]+$
Example:

"SITE-EXT-0001"

external_id
string

A optional custom ID that can be set to an internal ID from your system. This ID must be unique within all objects of the organisation you operate in. You can later use this external ID to reference and query this object. Be aware that you can update this ID later. If you need an immutable ID, use the object ID returned when creating the object.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9\-_]+$
Example:

"MY-CUSTOM-ID"

Response

The metadata of the newly uploaded file.

id
string
required

ID of the file.

Example:

"fle_01kw9grq4tecva35wdpstzcj5z"

external_id
string | null
required

Optionally assigned external ID of the file.

Example:

"MY-CUSTOM-ID"

site
object
required

The site that owns this file.

name
string
required

The original filename of the uploaded binary.

Example:

"sink_confirmation.pdf"

type
string
required

The MIME type of the file, detected from its contents at upload time.

Example:

"application/pdf"

size
integer
required

The size of the file in bytes.

Example:

482117

created_at
string<date-time>
required

The ISO 8601 timestamp at which the file was uploaded.

Example:

"2025-10-10T21:03:58Z"