Getting started
Authentication
We use two key authentication methods to identify you and your player. This layered authentication approach allows you to track usage statistics, manage costs, and remove access from abusive players if necessary — something you can't do with just a single API key.
Project Identification
API Key
All requests to the API must include an API key. This key is used to identify your game and authorize you as you. You can create as many API keys as you need.
Each API key has its own settings for text and image generation, including default settings to use when none are provided. However, you can also override these settings on a per-request basis.
Player Identification
Client ID
Most requests from the API also require a client ID. This ID is used to identify the player making the request, and can be any string value you want. Common examples are some kind of user identifier (ID, username, email, etc), a temporary session ID, or an anonymized GUID. Client IDs don't need to be globally unique, but should be unique within a given API key.
Unique client IDs allow you to track usage statistics for your game as a whole and also for individual players. This can help you identify popular features, track player retention, and identify (and remove access from) abusive players.
You can see statistics for your players on your API key's "Usage" page.