Upsert documents

Create or update one or more documents. 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

Alternatively, you can use the /connectors endpoint to programmatically fetch available API data sources.

The writes will be queued and processed in the background.

Send a maximum of 100 documents per request.

Rate Limits

600 requests per minute.

POST /documents/{data_source_id}

Upsert documents

cURL

curl --request POST \
  --url https://{subdomain}.withrealm.com/api/external/alpha/documents/{data_source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documents": [
    {
      "title": "<string>",
      "content": "<string>",
      "contentType": "markdown",
      "id": "<string>",
      "url": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "meta": {},
      "readAccess": [
        "<string>"
      ]
    }
  ]
}
'

200

{
  "results": [
    {
      "id": "<string>",
      "success": true,
      "error": "<string>"
    }
  ]
}

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

Send a maximum of 100 documents per request. The writes will be queued and processed in the background.

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

documents · object[] · required

Show child attributes

Response

200

application/json

Success

results · object[] · required

Show child attributes