Upload a file

This endpoint initiates an upload session and returns an uploadUrl for the session. Upload your file content using PUT requests to the returned uploadUrl. The file will be processed in the background and indexed into your knowledge base once the upload is complete.

curl -i -X PUT --data-binary @test.txt "$URL"

The resumable uploads use Google Cloud Storage - for more detailed documentation on how to perform the upload step (once you have generated the upload URL) see the Google Cloud Storage documentation.

This endpoint requires a data source ID. To get started:

1. Go to the Data sources page
2. Create a new API data source
3. Copy the data source ID from the data source details page
4. Use this ID in the path parameter

Rate Limits

600 requests per minute.

POST /documents/{data_source_id}/upload

Upload a file

cURL

curl --request POST \
  --url https://{subdomain}.withrealm.com/api/external/alpha/documents/{data_source_id}/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "meta": {},
  "mimeType": "<string>"
}
'

200

{
  "uploadUrl": "<string>",
  "sourceId": "<string>"
}

These endpoints require a custom API data source. See Custom API for setup instructions.

This endpoint returns an uploadUrl. Upload your file content using a PUT request to that URL. The file will be processed in the background and indexed into your knowledge base.

curl -X PUT --data-binary @yourfile.pdf "$UPLOAD_URL"

For detailed documentation on the upload step, see the Google Cloud Storage resumable uploads documentation.

Rate Limits

600 requests per minute.

Authorizations

Authorization · string · header · required

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

Path Parameters

data_source_id · string · required

Body

application/json

title · string · required

meta · object

Show child attributes

mimeType · string

Response

200

application/json

Success

uploadUrl · string · required

sourceId · string · required