Halluminate Web API Documentation

Use the Halluminate Web API to efficiently evaluate your generative models.

Getting started

Follow these instructions to help you get setup with evaluating your models:

1. If you do not have a Halluminate account, sign up here using your personal or business email. If you already have an account, log in here.

2. Once you create your account, verify your email by following the instructions to your inbox.

   Note: If you have verified your email and you lose your API key or its security is compromised, you can re-generate a new API key on the 'API Key' page on our webapp. As a reminder, DO NOT hard code your API key into any public github repositories.

3. Now you are ready to start creating Criteria! A criteria is a trait which you can use to evluate or benchmark your AI agent. Head to the criteria playground on our 'Criteria' page to clone a criteria template and familiarize yourself with editing the criteria's description and testing the criteria against text or a dataset.

4. When you feel comfortable with your criteria you have created, you are able to deploy it by using the 'Deploy' code. Make sure to include your personal API key as well as the criteria UUID and your model's output so that your deployment code runs seamlessly.