Quick Start
Welcome to the Quick Start guide for Vortex! This guide is designed to help you quickly set up and start using Vortex for your AI integrations. Follow these steps to get started.
Step 1: Request a Vortex Instance
Begin by requesting access to a Vortex instance. Reach out to us with details about your business and AI integration needs at vortex@adaptavist.com. If you're an internal member of Adaptavist, you can directly contact us through our Slack channel.
You'll receive an email with login details once your request has been processed.
Step 2: Set Up a Vortex Channel
Channels serve as the routes for your API requests to interact with Large Language Model providers.
For example, an OpenAI channel would link to the OpenAI provider, directing requests to the OpenAI API through Vortex.
To create a channel, refer to the instructions in Create a Channel.
Step 3: Create a Consumer
In Vortex, a consumer represents an entity using a Vortex API Key, such as an application that utilises the OpenAI provider. A unique Vortex API key identifies each consumer and can possess multiple API keys.
- Create a consumer by following the guidelines in Create a Consumer.
Step 4: Generate a Vortex API Key
A Vortex API key is essential for communication with Large Language Model providers. This key identifies your account and requests, aiding in cost and usage tracking.
- To generate a Vortex API key, see Generate a Vortex key.
Step 5: Connect Your Application to Vortex
Connecting your application is straightforward after setting up a channel and generating a Vortex API key for a consumer. The specific integration steps may vary depending on your application's language and framework, but Vortex API keys are generally used for authentication and establishing a secure connection.
- To connect to LLM via Vortex, see our Vortex Admin documentation.
Step 6: Verify Request Logging in Vortex
If you've successfully followed the steps above, your OpenAI requests should now be logging results in Vortex.
- To view these request logs, consult View request logs
What's next
Request Logs: Learn about filtering requests and viewing detailed logs in Vortex.
Integrations: Explore how to connect Vortex to OpenAI, including step-by-step guides and best practices.
Usage Limits: Understand how to set various usage limits to manage costs effectively.