Custom

By connecting a custom data source with Super, you can index specific data from any supported service and make it searchable directly in Super.
This guide will walk you through the key aspects of setting up and managing a custom data source connection, and  we'll take searching through tl;dv recordings as an example.⁠ 

Connecting a Custom Source & Super

This is the first step to get started. This section covers how to set up the connection between Super and your custom source.

Required Permissions for Setup

To connect Super and a custom source, you must have the necessary permissions in both platforms.
  • In Super: Permission to add or remove data sources depends on your team's settings. By default, only workspace admins or owners can set up a connection. However, a Super admin can enable a setting to allow all members to add and remove data sources.
  • In the Custom Source: You must have access to the Custom Source you want to index.

Initial Connection

Creating a Custom Source in Super

To begin, you need to create your custom source and get the necessary credentials.
    In Super, click Data Sources in the left sidebar.
    Find the Custom option and give your source a name (e.g., "tl;dv — Mathieu"), then click Create.
    In the Sources tab, click the three-dot menu next to the source and select "Copy ID".

Indexing a Custom Source via the Public Super API

You will need an API key to authenticate with the public Super API.
    Click your team avatar in the top-left corner.
    Click Settings, then scroll down to the API section.
    Click Create new key and follow the on-screen instructions
You can then call the /ask/index endpoint, pushing one object at a time in markdown or HTML. You can use the service of origin’s ID as a reference to update an existing object, and the updatedAt key to indicate Super how recent the information is.
For detailed API documentation, visit:
You can then go back to the Sources tab and see the count of objects indexed for a given Custom Source. You'll be able to use your Custom Source everywhere in Super as a Data Source.

Indexing a Custom Source via Zapier (tl;dv Example — Expand section for more details...)

For an easier configuration, you can use our  Zapier integration  to index objects from their interface. Let's take tl;dv as an example. We'll set things up so that each new tl;dv transcript is indexed in Super.
    Sign in to your Zapier account and find the Super app.
    Choose to pair it with the tl;dv app.
    Click Connect these apps.
    Select the tl;dv trigger event (e.g., “New Recording”) and click Continue to test your trigger.
    If you haven't already, you'll be prompted to connect your tl;dv account and get an API key from their website.
    Choose a record and click Continue with selected record.
    For Super, choose the Index Custom Content action event, then click Continue.
    You'll also want to make sure your Super account is connected.
    You will be prompted to configure the Index Custom Content action. Click the + button next to each field to fill in the details. Once you are done, click Continue.
The custom source id is the piece of information you got  earlier in the process⁠ .
    Click Test, then Publish if the test is successful.
    If the test fails, go back to the previous step and make sure the details are correct.

Access Control & Privacy

Custom sources do not support specific permissions. All Super members can search and ask on the custom sources that have been added to your workspace.