Documentation Index
Fetch the complete documentation index at: https://simili.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
OpenAI Configuration
Simili Bot v0.2.0 supports OpenAI as a full alternative to Google Gemini for both embeddings and LLM analysis.Getting started
1. Get API key
- Go to platform.openai.com
- Sign in with your OpenAI account
- Click Create new secret key
- Copy the generated API key
2. Set up GitHub secret
Store your API key securely:- Go to repository Settings → Secrets and variables → Actions
- Create secret
OPENAI_API_KEY - Paste your API key
3. Configure Simili Bot
Add to.github/simili.yaml:
Configuration reference
Embedding settings
| Property | Type | Description | Required |
|---|---|---|---|
provider | string | Must be "openai" | Yes |
api_key | string | OpenAI API key | Yes |
model | string | Embedding model | No (default: text-embedding-3-small) |
dimensions | number | Must match model output | Yes |
LLM settings
| Property | Type | Description | Default |
|---|---|---|---|
provider | string | Must be "openai" | Inherits from embedding |
api_key | string | OpenAI API key | Inherits from embedding |
model | string | LLM model | gpt-5.2 |
Available models
Embedding models
| Model | Dimensions | Notes |
|---|---|---|
text-embedding-3-small | 1536 | Default, cost-efficient |
text-embedding-3-large | 3072 | Highest quality |
text-embedding-ada-002 | 1536 | Legacy, not recommended |
Provider precedence
If bothGEMINI_API_KEY and OPENAI_API_KEY are set, Gemini takes priority.
To use only OpenAI:
- Only set
OPENAI_API_KEY(do not setGEMINI_API_KEY), or - Explicitly configure
provider: "openai"in yoursimili.yaml
Mixed providers
You can use different providers for embeddings and LLM:Common issues & solutions
Invalid API key
Error:Error 401: Incorrect API key provided
Solutions:
- Verify the key is correct from platform.openai.com
- Ensure no extra whitespace in the secret value
- Check the key has not been revoked
Rate limited
Error:Error 429: Rate limit reached
Solutions:
- Reduce worker count during bulk indexing
- Upgrade your OpenAI tier for higher limits
Dimension mismatch
Error:collection dimension mismatch
Make sure dimensions matches the model:
Next steps
Gemini configuration
Use Gemini instead
Environment variables
Configure API keys
OpenAI integration reference
Technical integration details

