Skip to main content

​
One API, two kinds of keys

ROOTKey has a single public API at https://api.rootkey.ai. There is no separate development host: you test against the same API you use in production, with a test API key. The key decides what a request works on: You call the same endpoints with either kind of key.

​
Test data and live data

Test data and live data are kept separate inside your organization:
  • Vaults, tables, files, and records created with a test key are visible only to test keys, and the same is true the other way round.
  • A vault or table address created with one kind of key is not found by the other.
  • Test data does not carry over when you move to live. Create your vaults and tables again with a live key.

​
What a test key does not change

A test key is not exempt from your plan:
  • Requests made with a test key count toward your plan’s usage limits, the same way requests made with a live key do. See Rate Limits.
  • The limits that count requests by client IP address apply to test keys as they do to live keys. See Rate Limits.

​
Create a test key

In Developer Tools, turn on test mode, then create the key as described in API Keys. A key created while test mode is on is a test key. Send it in the x-api-key header like any other key. See Authentication.

​
Move to live

When your integration is ready, create a live API key with test mode off and replace the key in your environment configuration. The base URL does not change.