---
title: "Set up a Tulip API Token"
slug: "set-up-a-tulip-api"
tags: ["Table API", "Tulip API", "Set Up", "API"]
updated: 2026-03-25T18:03:28Z
published: 2026-03-25T18:03:28Z
canonical: "support.tulip.co/set-up-a-tulip-api"
---

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

# Set up a Tulip API Token

*Follow this guide to set up your API after downloading library content.*

**Access Tulip's [API documentation here](https://support.tulip.co/apidocs).**

          Who can use this feature

          

Users on Professional plans and above.

          Advanced Content

          

This article assumes previous experience with APIs.

Set up and use the Tulip API to interact with Tulip from other systems.

Tulip interacts with many other system's APIs via Connectors. Using [connectors](https://support.tulip.co/docs/what-are-connectors), a Tulip app can initiate an HTTP or SQL query.

In other cases, you may want to allow an external system to query data that only exists within Tulip. It is possible to communicate with Tulip from external systems using the Tulip API. This article will walk through the set up and testing for the Tulip API.

The Tulip API is useful for integrating these external systems with Tulip in many ways. The API currently works with Tulip [Tables](https://support.tulip.co/r230/docs/an-overview-of-tables), [Operators](https://support.tulip.co/r230/docs/using-the-user-api), [Machines](https://support.tulip.co/docs/how-to-use-the-machine-attributes-api), and Apps scopes.

## Adding an API

1. Create an API Token using the Tulip API by clicking on **Settings** in the top right. You can choose either account (that work globally) or workspace depending on if your instance has workspaces enabled.

![image.png](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/image%28456%29.png)

1. Then create an **API Token**.

![image.png](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/image%28458%29.png)

1. Grant the API Token the appropriate scopes depending on what you need.

![image.png](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/image%28459%29.png)

This will generate credentials for you to set up your API Connector. It is a good idea to save these somewhere. Leave this window open while you open up a new window.

![Screenshot 2024-02-24 at 5.25.23 PM.png](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Screenshot%202024-02-24%20at%205.25.23%20PM.png)

In your other window, navigate to your connectors and select the new HTTP connector called "Table API" and edit the connection settings.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Setting%20up%20the%20Table%20API%20%28for%20the%20Library%29_240720188.png)

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Setting%20up%20the%20Table%20API%20%28for%20the%20Library%29_240720382.png)

Choose **Cloud Connector Host** and enter in your Tulip Instance as the host. Then click **Edit Headers**.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/Setting%20up%20the%20Table%20API%20%28for%20the%20Library%29_240720730.png)

Choose **Basic Auth** and enter in your API Key (from the previous window) as the Username and your Secret as your Password.

Your API is now set up!

---

Did you find what you were looking for?

You can also head to [community.tulip.co](https://community.tulip.co) to post your question or see if others have faced a similar question!

**Connectors**

**Connectors** enable real-time connectivity between your Tulip solution and a transactional system (e.g. an ERP). The output of a Connector Function can be used in Tulip Apps, Automations, and Functions.

- **HTTP Connectors** utilize HTTP API endpoints.
- **SQL Connectors** can enable connectivity with certain SQL databases.
- **MQTT Connectors** can connect to MQTT brokers for machine monitoring.

![](https://cdn.document360.io/7c6ff534-cad3-4fc8-9583-912c4016362f/Images/Documentation/connector.gif)

**Connector Host**

Tulip **Connector Hosts**are designed to allow your Tulip Apps to interface with external systems such as databases, APIs, and machines. **On-Prem Connector Hosts**sit within your network and allow Tulip to interface with SQL databases and APIs that aren't accessible to the cloud.

**Tulip Instance**

A Tulip customer account. Your instance can be found at https://[your-instance].tulip.co

When *your instance*is referenced, we are just talking about your Tulip account on an organization-level, not user-level.