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

# Outline Connector

> Index Outline collections and documents via the Outline API

## How it works

The Outline connector calls the Outline API to index **collections** (name and description) and **documents** (title and body text), with links back to your Outline workspace. Incremental runs filter by each item’s `updatedAt` after a full list is fetched.

Updates are applied on the connector’s scheduled runs (typically **daily**).

## Setting up

### Authorization

You need your Outline instance **base URL** and an **API token**:

* **Outline Base URL** — e.g. `https://app.getoutline.com` for Outline Cloud, or the root URL of your **self-hosted** Outline deployment (must be reachable from Hymalaia).
* **Outline API Token** — create under workspace **Settings → API & applications** (or equivalent for self-hosted); the token must be allowed to list and read documents and collections.

### Indexing

<Steps>
  <Step title="Open Outline connector">
    In the Hymalaia Admin Panel, open the **Outline** connector.
  </Step>

  <Step title="Configure authorization">
    In **Step 1**, set up credentials:

    * Select an existing credential, or click **Create New**
    * Enter **Outline Base URL** and **Outline API Token**
  </Step>

  <Step title="Save configuration">
    Click **Create** to save the credential configuration.
  </Step>

  <Step title="Continue with selected credential">
    Ensure the correct credential is selected, then click **Continue**.
  </Step>

  <Step title="Finish connector setup">
    In **Step 2**, set:

    * **Connector Name** — a display name (e.g. `Outline – Product`)
    * **Access Type** — **Public** or **Private** in Hymalaia
  </Step>

  <Step title="Create connector">
    Click **Create Connector** to start indexing.
  </Step>
</Steps>

For API details, see the [Outline developer documentation](https://www.getoutline.com/developers).
