Skip to main content

OpenAPI Connection

This page provides a step-by-step guide on establishing an OpenAPI connection between Timbr and Retool. It details how to gather the required credentials (including the Timbr user token and the knowledge graph specification URL), configure the integration in Retool, and resolve common issues that may arise during the setup process.

Gather Connection Details​

To configure the OpenAPI connection in Retool, first gather these details:

  1. Your Timbr user token.
  2. The specification URL of the knowledge graph you want to query.

Copy the Timbr User Token​

  1. From the main welcome page (accessible by clicking the Timbr logo), locate the top-left container.

  2. Click the Copy user token button.

    Copy Specification URL

Copy the Specification URL​

In the OpenAPI Swagger UI, copy the URL beneath the main Timbr API - OpenAPI 3.0 title.

Copy Specification URL

Accessing the Swagger UI from the Timbr Platform

There are two ways to access the OpenAPI Swagger UI from Timbr:

  1. Click the Help menu icon in the top-right corner of the Timbr platform to open the main Swagger UI component.
    Then, select the desired knowledge graph from the dropdown in the top-right corner.

    Link to main Swagger UI

    Link to specific Swagger UI

  1. From the Ontology Explorer page, choose the knowledge graph you want to query.
    Then click the Swagger icon in the top-right menu bar to open the Swagger UI for that specific knowledge graph.

    Link to specific Swagger UI

Creating Timbr OpenAPI as a Retool Resource​

  1. In Retool, go to Resources, click Create new, and select Resource.
  2. Under the APIs category, select OpenAPI.
  3. In the configuration window, specify:

General​

  • Name: A recognizable name for your knowledge graph or resource in Retool.

Credentials​

  • Specification URL: The URL you copied earlier.
    • Check the Forward headers when fetching OpenAPI spec. option.
  • Headers:
    • Key: x-api-key
    • Value: Your copied Timbr user token OpenAPI headers

  1. Click Create resource.

    danger

    If you encounter issues, consult the Retool error messages and confirm the correct values.

Connecting Timbr OpenAPI to Retool App​

  1. Open your Retool app. Drag in the desired component, and in the right panel, use the Data Source dropdown.

    • Select Connect Data.

      Connect Data Source to Retool App

  2. On the left panel, under Resources, locate the resource you just created and click on it.

    Select Resource for Retool App

  3. Under Operation, choose the concept you want to query. Click Save & Run.

    Select Operation and Run Retool App

    Integration Complete

Now that Retool is linked to your Timbr knowledge graph, you can generate interactive dashboards, explore relationships across entities, and run real-time queries. Combine multiple data sources for richer insights, design forms to create or update resources, and leverage Timbr’s semantic layer to quickly validate and interpret data within any Retool application.