> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withrealm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> Programmatic access to Realm's core capabilities

## Overview

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

<CardGroup cols={2}>
  <Card title="Push API" icon="upload">
    Add, update, and delete documents in Realm from external sources for which Realm does not have a native connector.
  </Card>

  <Card title="Pull API" icon="download">
    Integrate a Realm Assistant into other applications, such as your company's own product or help center.
  </Card>
</CardGroup>

## Personal API keys

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

### How to generate your personal API keys

<Steps>
  <Step title="Navigate to API keys">
    Go to Settings > API keys in the Realm sidebar.
  </Step>

  <Step title="Create new key">
    Create new keys and manage existing ones.
  </Step>

  <Step title="Configure permissions">
    When creating a key, give it a name and configure its permissions.
  </Step>

  <Step title="Save your token">
    Save your token in a safe place, as you will not be able to view it again.
  </Step>
</Steps>

<Note>
  API implementation and management of organization-wide keys require developer or administrator access. The API is available on Scale and Enterprise plans.
</Note>

## Related resources

<CardGroup cols={2}>
  <Card title="API Documentation" icon="book" href="/api-reference">
    View the complete API reference
  </Card>

  <Card title="Connectors" icon="plug" href="/admin/data-sources/overview">
    Connect your data sources to Realm
  </Card>
</CardGroup>