Home
Community TemplatesProven templates you can copy and adapt quickly.DocumentationGuides, references, and best practices for Orbitype.BlogArticles with practical automation strategies and examples.
Log inSign up
Documentation6.9

Create an API key

An API key is scoped to one connector. SQL and S3 requests send it as the X-API-KEY header.

On this page

Create it

  1. Open API Keys.
  2. Create a key.
  3. Choose the SQL connector or the storage connector.
  4. Copy the key when it is shown.

Send it on every request:

X-API-KEY: YOUR_API_KEY

An OPTIONS request to https://core.orbitype.com/api with that header returns projectId and connectorId. projectId is the workspace id.

Inside a workflow or an app

You do not paste the key into node code. orbi.project.apiKeys already contains the keys for this workspace. The field is named project. It is the workspace. Match connectorId when you have more than one.