> ## Documentation Index
> Fetch the complete documentation index at: https://portkey-docs-feat-rerank-documentation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Lemonfox-AI
> Integrate LemonFox with Portkey for chat, image generation, and speech-to-text.
## Quick Start
Get started with LemonFox AI in under 2 minutes:
```python Python icon="python" theme={"system"}
from portkey_ai import Portkey
# 1. Install: pip install portkey-ai
# 2. Add @lemonfox-ai provider in model catalog
# 3. Use it:
portkey = Portkey(api_key="PORTKEY_API_KEY")
response = portkey.chat.completions.create(
model="@lemonfox-ai/llama-8b-chat",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
```
```js Javascript icon="square-js" theme={"system"}
import Portkey from 'portkey-ai'
// 1. Install: npm install portkey-ai
// 2. Add @lemonfox-ai provider in model catalog
// 3. Use it:
const portkey = new Portkey({
apiKey: "PORTKEY_API_KEY"
})
const response = await portkey.chat.completions.create({
model: "@lemonfox-ai/llama-8b-chat",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
```
```python OpenAI Py icon="python" theme={"system"}
from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL
# 1. Install: pip install openai portkey-ai
# 2. Add @lemonfox-ai provider in model catalog
# 3. Use it:
client = OpenAI(
api_key="PORTKEY_API_KEY", # Portkey API key
base_url=PORTKEY_GATEWAY_URL
)
response = client.chat.completions.create(
model="@lemonfox-ai/llama-8b-chat",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
```
```js OpenAI JS icon="square-js" theme={"system"}
import OpenAI from "openai"
import { PORTKEY_GATEWAY_URL } from "portkey-ai"
// 1. Install: npm install openai portkey-ai
// 2. Add @lemonfox-ai provider in model catalog
// 3. Use it:
const client = new OpenAI({
apiKey: "PORTKEY_API_KEY", // Portkey API key
baseURL: PORTKEY_GATEWAY_URL
})
const response = await client.chat.completions.create({
model: "@lemonfox-ai/llama-8b-chat",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
```
```sh cURL icon="square-terminal" theme={"system"}
# 1. Add @lemonfox-ai provider in model catalog
# 2. Use it:
curl https://api.portkey.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-d '{
"model": "@lemonfox-ai/llama-8b-chat",
"messages": [{"role": "user", "content": "Hello!"}]
}'
```
## Add Provider in Model Catalog
Before making requests, add LemonFox AI to your Model Catalog:
1. Go to [**Model Catalog → Add Provider**](https://app.portkey.ai/model-catalog/providers)
2. Select **LemonFox AI**
3. Enter your [LemonFox API key](https://www.lemonfox.ai/apis/keys)
4. Name your provider (e.g., `lemonfox-ai`)
See all setup options and detailed configuration instructions
Explore the official Lemonfox AI documentation
***
## LemonFox Capabilities
### Streaming
Stream responses for real-time output:
```python Python theme={"system"}
from portkey_ai import Portkey
portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@lemonfox-ai")
stream = portkey.chat.completions.create(
model="llama-8b-chat",
messages=[{"role": "user", "content": "Tell me a story"}],
stream=True
)
for chunk in stream:
print(chunk.choices[0].delta.content or "", end="", flush=True)
```
```javascript Node.js theme={"system"}
import Portkey from 'portkey-ai';
const portkey = new Portkey({
apiKey: 'PORTKEY_API_KEY',
provider: '@lemonfox-ai'
});
const stream = await portkey.chat.completions.create({
model: 'llama-8b-chat',
messages: [{ role: 'user', content: 'Tell me a story' }],
stream: true
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content || '');
}
```
### Image Generation
Generate images with Stable Diffusion XL:
```python Python theme={"system"}
from portkey_ai import Portkey
portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@lemonfox-ai")
image = portkey.images.generate(
prompt="A cute baby sea otter",
size="1024x1024"
)
print(image.data[0].url)
```
```javascript Node.js theme={"system"}
import Portkey from 'portkey-ai';
const portkey = new Portkey({
apiKey: 'PORTKEY_API_KEY',
provider: '@lemonfox-ai'
});
const image = await portkey.images.generate({
prompt: "A cute baby sea otter",
size: "1024x1024"
});
console.log(image.data[0].url);
```
### Speech-to-Text
Transcribe audio with Whisper:
```python Python theme={"system"}
from portkey_ai import Portkey
portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@lemonfox-ai")
audio_file = open("/path/to/file.mp3", "rb")
transcription = portkey.audio.transcriptions.create(
model="whisper-1",
file=audio_file
)
print(transcription.text)
```
```javascript Node.js theme={"system"}
import Portkey from 'portkey-ai';
import fs from 'fs';
const portkey = new Portkey({
apiKey: 'PORTKEY_API_KEY',
provider: '@lemonfox-ai'
});
const transcription = await portkey.audio.transcriptions.create({
file: fs.createReadStream("/path/to/file.mp3"),
model: "whisper-1"
});
console.log(transcription.text);
```
***
## Supported Endpoints and Parameters
| Endpoint | Supported Parameters |
| ----------------------- | ----------------------------------------------------------------------------------------- |
| `/chat/completions` | messages, max\_tokens, temperature, top\_p, stream, presence\_penalty, frequency\_penalty |
| `/images/generations` | prompt, response\_format, negative\_prompt, size, n |
| `/audio/transcriptions` | translate, language, prompt, response\_format, file |
***
## Next Steps
Add fallbacks, load balancing, and more
Monitor and trace your LemonFox requests
Manage and version your prompts
Add custom metadata to requests
For complete SDK documentation:
Complete Portkey SDK documentation