Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
default:YOUR_API_TOKEN
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

data_source_id
string
required

ID of the custom API data source.

Body

application/json
title
string
required
id
string

Optional unique identifier for the document. We enforce uniqueness on our end. Calling this endpoint again with the same id will overwrite the previously uploaded document once the new upload finishes processing. If not provided, a UUID will be generated automatically and returned as sourceId in the response. Must be alphanumeric and can include underscores and hyphens.

Pattern: ^[a-zA-Z0-9_-]+$
meta
object
mimeType
string
url
string<uri>
createdAt
string<date-time>

UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')

updatedAt
string<date-time>

UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')

readAccess
string[]

Email addresses of the users that have read access to the document. If not provided, the document can be seen by anyone in Realm. Cannot be an empty array — omit the field instead.

Minimum array length: 1
verified
boolean

When true, marks the uploaded document as verified after processing. Include it on future uploads for the same source ID while the source system still treats it as authoritative; omitting it or sending false stops asserting source verification.

Response

Success

uploadUrl
string
required
sourceId
string
required