Create your Itzi key
Open the Itzi API dashboard and sign in. Under API keys, enter a name for this app and click Create. Copy the secret immediately: it is shown only once. Keep a separate key for each app and paste it only into its API key field.
Choose a model your account can access. Requests use your Itzi balance or subscription according to the key settings. The example keys in these screenshots do not work.
Open API dashboardConnection details
Base URL
https://itzi.app/v1For a field that asks for the complete Chat Completions endpoint instead, use https://itzi.app/v1/chat/completions.
- API key
- Your full Itzi key, starting with
itzi_sk_. - Model
- An exact model ID from your API dashboard or
/v1/models.
Set up the connection
Choose a custom OpenAI-compatible provider
Open your client's model or connection settings. Look for a custom provider using the OpenAI Chat Completions format. A client with a fixed provider URL cannot connect to Itzi through that setting.
Enter the connection details
Paste the URL from Connection details and your Itzi API key into the matching fields. If the client asks for a complete endpoint, use the full /v1/chat/completions URL instead. Do not include Bearer in an API Key field; clients normally add it themselves.
Refresh the model list
Use the client's model discovery button, or copy an exact model ID from the Itzi API dashboard. Model discovery calls GET /v1/models using your key. Do not assume a model listed for another provider has the same ID on Itzi.
Save and test text generation
Select the connection and send a short text prompt. This uses your Itzi balance or subscription allowance. Once text works, enable streaming if supported, then check the selected model's capabilities before enabling images or tools.
If something does not work
Compatibility depends on the feature
Chat Completions supports text and streaming. Vision and tools depend on the model. Itzi does not currently expose embeddings, audio, Assistants or a public file-upload API. Client features that require those routes need another service.
Use your own instance address when self-hosting
These guides target itzi.app. For a self-hosted Itzi installation, copy the Base URL from that instance's API dashboard and create the key there.
Invalid key or 401
Copy the entire Itzi key without spaces. If it was revoked or lost, create a replacement in the API dashboard. An upstream provider key cannot replace an Itzi key.
Payment or access error
Check your balance, subscription allowance and the API key's subscription settings. A model shown in the public catalog may require access your key does not have.
Model not found or an empty model list
Refresh the model list using your key. Copy the exact ID from the API dashboard, then confirm the endpoint and key were saved before model discovery.
Too many requests or 429
Wait before retrying and reduce parallel requests. Chat messages and background agents share your limits. Check the error message for a rate, concurrency or subscription limit.
Long chats fail or responses are empty
Test a short conversation first. Lower the client's context and output limits, including character, lorebook and system prompts in that budget. Check Itzi Status if a short request also fails.