API / README.md
Rox-Turbo's picture
Update README.md
6c15b4a verified
---
title: Rox AI
emoji: 🤖
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
pinned: false
---
# Rox AI
Eight specialized AI models by Mohammad Faiz.
**API**: `https://Rox-Turbo-API.hf.space`
## Models
| Model | Endpoint | Use Case |
|-------|----------|----------|
| Rox Core | `/chat` | General conversation |
| Rox 2.1 Turbo | `/turbo` | Fast responses |
| Rox 3.5 Coder | `/coder` | Code generation |
| Rox 4.5 Turbo | `/turbo45` | Advanced reasoning |
| Rox 5 Ultra | `/ultra` | Complex tasks |
| Rox 6 Dyno | `/dyno` | Long context |
| Rox 7 Coder | `/coder7` | Advanced coding |
| Rox Vision Max | `/vision` | Visual understanding |
## Quick Start
```bash
curl -X POST https://Rox-Turbo-API.hf.space/chat \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","content":"Hello"}]}'
```
## Usage
### Request
```json
{
"messages": [
{"role": "user", "content": "Your message"}
],
"temperature": 1.0,
"max_tokens": 512
}
```
### Response
```json
{
"content": "AI response"
}
```
### JavaScript
```javascript
async function askRox(message, model = 'chat') {
const response = await fetch(`https://Rox-Turbo-API.hf.space/${model}`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
messages: [{ role: 'user', content: message }]
})
});
return (await response.json()).content;
}
```
### Python
```python
import requests
def ask_rox(message, model='chat'):
response = requests.post(
f'https://Rox-Turbo-API.hf.space/{model}',
json={'messages': [{'role': 'user', 'content': message}]}
)
return response.json()['content']
```
## Examples
```bash
# General conversation
curl -X POST https://Rox-Turbo-API.hf.space/chat \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","content":"Explain AI"}]}'
# Fast response
curl -X POST https://Rox-Turbo-API.hf.space/turbo \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","content":"What is 2+2?"}]}'
# Code generation
curl -X POST https://Rox-Turbo-API.hf.space/coder \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","content":"Write a Python function"}]}'
# Advanced reasoning
curl -X POST https://Rox-Turbo-API.hf.space/turbo45 \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","content":"Explain quantum computing"}]}'
```
## Documentation
- [Code Examples](docs/CODE.md) - Copy-paste code
- [Developer Guide](docs/DEVELOPER_GUIDE.md) - Integration guide
- [Models Guide](docs/MODELS.md) - Model details
- [API Reference](docs/API_REFERENCE.md) - API docs
## Model Selection
- **Rox Core** - General use
- **Rox 2.1 Turbo** - Speed priority
- **Rox 3.5 Coder** - Code tasks
- **Rox 4.5 Turbo** - Complex reasoning
- **Rox 5 Ultra** - Highest quality
- **Rox 6 Dyno** - Long documents
- **Rox 7 Coder** - Advanced code
- **Rox Vision Max** - Images
## License
MIT License
---
Built by Mohammad Faiz