What can the elvex API can be used for?
The elvex API can be used to access the agents that are available in your elvex account so you can integrate these agents into other platforms or workflows. For example, you may have an agent 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 agent 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 and click Create an API key. You can also manage existing tokens from this page.
API Key Workflow
The process of using API keys with agents involves coordination between Admin users and agent owners:
Step 1: Admin generates the API key
Only Admin users can create API keys in
When creating the key, the admin assigns it a descriptive name
Step 2: Admin shares the key name
The admin shares the name of the API key as well as the actual key value with the agent owner
The key name is what will be used to grant access to the agent
Step 3: Agent owner adds API access
Navigate to your agent's configuration settings
Under the Security and Permissions section, search for the API key name provided by the admin and add it as an Editor
Select the API key name and click Save & Publish
API Documentation
Please refer to our API documentation to see a full reference as well as guides we'll continue to develop over time.