API Overview
Welcome to the Quiva API! This API allows you to interact with Quiva models such as Quiva X, Quiva Vision, Quiva Voice, Quiva Pro X, and Image X. You can use these models to enhance your applications with AI-based responses, image generation, and more.
Quiva Models
Quiva X
Quiva X is our high-performance, token-based AI model. Suitable for large-scale tasks requiring fast and efficient responses.
Quiva Vision
Quiva Vision is an image-based AI model designed for tasks like image generation and analysis.
Quiva Pro X
Quiva Pro X is the advanced token-based model for professional-grade AI tasks with optimized input-output performance.
Quiva Pro
Quiva Pro is designed for mid-tier tasks, offering a balance between speed and accuracy.
Image X
Image X is our token-based model for image manipulation, analysis, and generation, delivering high-quality output based on tokens.
Quiva Voice
Quiva Voice is our intelligent voice assistant, designed for seamless interactions and enhanced user experiences.
Authentication
To use any of the Quiva models, you need to authenticate with an API key. Please follow the steps below to request your API key:
- Contact us at support@quivox.org to request an API key.
- Once your request is approved, you will receive your API key via email.
- Use the API key in the `Authorization` header for all API requests.
Authorization: Bearer YOUR_API_KEY
API Endpoints
POST /api/quiva-x-[basic|advanced]/generate-response
Use this endpoint to generate text responses using Quiva X.
curl -X POST https://ai.quivox.org/api/quiva-x-{basic|advanced}/generate-response -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"username": "your_ai_username", "prompt": "your_ai_prompt" }'
POST /api/quiva-vision/generate-image
Generate images using Quiva Vision by passing a prompt.
curl -X POST https://ai.quivox.org/api/quiva-vision/generate-image -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"username": "your_ai_username", "prompt": "your_image_description"}'
POST /api/quiva-pro-x-[basic|advanced]/generate-response
Use Quiva Pro X for professional-grade AI responses.
curl -X POST https://ai.quivox.org/api/quiva-pro-x-{basic|advanced}/generate-response -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"username": "your_ai_username", "text": "your_text", "id": "your_histroy_id", "prompt": "your_ai_prompt"}'
POST /api/quiva-voice/generate-voice
Use Quiva Voice to generate audio based responses.
curl -X POST https://ai.quivox.org/api/quiva-voice/generate-voice -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"username": "your_username", "text": "your_text_here"}'
POST /api/image-x/generate-response
Use Quiva Image X for advanced image analysis and generation tasks.
curl -X POST https://ai.quivox.org/api/image-x/generate-response -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"username": "your_username", "prompt": "your_prompt", "imageUrl": "your_image_url"}'
Usage Examples
Here are examples of how to use Quiva API models:
Example: Quiva X Response Generation
const fetchResponse = async () => {
const response = await fetch('https://ai.quivox.org/api/quiva-x-advanced/generate-response', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ prompt: 'Imagine you are Batman....', username: 'batman09' }),
});
const data = await response.json();
console.log(data);
};
Example: Quiva Vision Image Generation
const generateImage = async () => {
const response = await fetch('https://ai.quivox.org/api/quiva-vision/generate-image', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ username: 'your_username', prompt: 'your_image_description' }),
});
const data = await response.json();
console.log(data);
};
Example: Quiva Voice Generation
const generateVoice = async () => {
const response = await fetch('https://ai.quivox.org/api/quiva-voice/generate-voice', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ username: 'your_username', text: 'your_text' }),
});
const data = await response.json();
console.log(data);
};