Skip to main content

Using the elvex API

Information on the elvex API and access to the API reference

Updated yesterday

What can the elvex API can be used for?

The elvex API can be used to access the assistants that are available in your elvex account so you can integrate these assistants into other platforms or workflows. For example, you may have an assistant that functions as a customer support copilot that you'd like to integrate with the support ticketing system you're using. The elvex API can help you bring the copilot assistant into the natural workflow for the customer support team.

Authentication

All endpoints require API key credentials provided via HTTP bearer tokens.

GET /endpoint HTTP/1.1
Host: api.elvex.ai
Authorization: Bearer <your API key>

If you are an Admin user, you can create a new API key in your elvex account by heading to Settings > API Keys and click Create an API key. You can also manage existing tokens form this page.

API Documentation

Please refer to our API documentation to see a full reference as well as guides we'll continue to develop over time.

Enabling API Use for an Assistant

Once an API key is generated from the elvex settings, any owner or editor of an assistant may add that API key as an allowed user on the assistant. This is a necessary step for the assistant to be used via the API.

To add an API user to an assistant, navigate to the configuration settings for that assistant. Under the Security and Permissions section, use the search bar to enter in the name of the API key that was generated, and select it. Once you click Save & Publish, this assistant will be usable by the API.

Did this answer your question?