​
1. Create an Account

If you haven’t already, start by creating an account through our signup page. Once you successfully create an account, you will be redirected to our dashboard.

​
2. Create your first Prompt

The prompt is central to all requests made to Optimix. It contains your prompt text (which acts as the system prompt for your requests) and specifies the model used for the prompt. You will use the Prompt ID to identify which prompt/model we should use when handling your requests. This ID can be found in the first column of the prompts page.

Create your prompt

​
3. Test and Run your Prompt in the Playground

The Playground allows you to test your prompts with live requests right in the dashboard. You can test a previously saved prompt (like the one you created the last step) or test a completely new prompt and model configuration. Requests from the Playground will be automatically logged, so you can view them on both the Dashboard and Logs pages.

Prompt Playground

​
4. Generate an API Key

You can create a new API key on the settings page. Keep the API key somewhere safe as you won’t be able to recover it if it gets lost. You can also always delete or create new API keys if needed.

Create an API key

On this same page, you can also set up your model provider API keys. Adding keys for a provider here enables you to make requests to all models from that provider. It also enables the Optimix Router to automatically route to the best model across all the providers you have enabled.

Create an API key

​
5. Run your first API Request

Use one of our two API endpoints (completion or conversation) to run your first request. You will need your API Key and Prompt ID, as well as any additional inputs you would like to pass in to the model. More details can be found in the API Overview page.

​
6. You’re Done! View your Logs

You can now view your requests from the API and Playground on both the Dashboard and Logs pages. You can use the details page to view more information about your request.

Logs and Graphs in Dashboard

​
Explore more features!

Check out our Experiments Doc next to see how you can test your changes safely and live!