​
What Are API Keys?

API keys are unique codes that let different software talk to each other. They act as a way to identify who is trying to connect and make sure the connection is secure.

Think of an API key like a special key card you use to enter a building. It tells the system who you are and what you’re allowed to do. Every time an app wants to connect to another app, it shows this key card.

You can think of API keys as a form of a password so these should never be shared.

​
Relevance API Keys

You can also generate your own Relevance API key to use tools or agents in other platforms.

​
Custom API Keys

If the integration you would like to use is not on the list, you can add a custom one.

To access your custom keys, you can get to it using {{secrets.chains_your_api_key}}

​
Region and URL endpoints

Many API endpoints at Relevance follow the below format. Note the api-<region> part.

https://api-<region>.stack.tryrelevance.com/latest/.......

For instance, if the Region id fetched from the API keys page is f1db6c:

https://api-f1db6c.stack.tryrelevance.com/latest/.......

On the sidebar, you have access to

  • Home: your home page on Relevance
  • Agent: your own AI assistant powered by LLMs and tools
  • Tools: analysis tools/flows powered by LLMs
  • Knolwedge: sources of truth provided by you in variety of acceptable formats such as PDF, CSV, Audio
  • Templates: variety of analysis tools / flows built and maintained by Relevance