Skip to main content

​
Overview

Realm provides an API that allows programmatic interaction with Realm’s core capabilities outside of the main web application.

Push API

Add, update, and delete documents in Realm from external sources for which Realm does not have a native connector.

Pull API

Integrate a Realm Assistant into other applications, such as your company’s own product or help center.

​
Personal API keys

You can generate and manage your own personal API keys to authenticate requests.

​
How to generate your personal API keys

1

Navigate to API keys

Go to Settings > API keys in the Realm sidebar.
2

Create new key

Create new keys and manage existing ones.
3

Configure permissions

When creating a key, give it a name and configure its permissions.
4

Save your token

Save your token in a safe place, as you will not be able to view it again.
API implementation and management of organization-wide keys require developer or administrator access. The API is available on Scale and Enterprise plans.

API Documentation

View the complete API reference

Connectors

Connect your data sources to Realm