Authentication
All API endpoints require a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
POST
/v1/audio/transcriptions
Speech-to-text transcription using Whisper. Upload an audio file and get the transcribed text.
Parameters:
file — Audio file (multipart/form-data)model — Model name (default: "stt")language — Optional language hint (e.g., "en", "fr")
curl -X POST https://models.awesome.icu/v1/audio/transcriptions -H "Authorization: Bearer YOUR_API_KEY" -F "file=@audio.mp3" -F "model=stt"
OCR
Optical Character Recognition
Extract text from images using PaddleOCR PP-OCRv4 on Intel Arc GPU. Three input methods available:
POST
/v1/ocr
OCR from image file upload (multipart/form-data, field file).
curl -X POST https://models.awesome.icu/v1/ocr -H "Authorization: Bearer YOUR_API_KEY" -F "file=@image.png"
POST
/v1/ocr/url
OCR from a publicly accessible image URL.
curl -X POST https://models.awesome.icu/v1/ocr/url -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"url": "https://example.com/image.png"}'
POST
/v1/ocr/base64
OCR from a base64-encoded image string.
curl -X POST https://models.awesome.icu/v1/ocr/base64 -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"url": ""}'
OCR Response Format:
{
"results": [
{
"text": "detected text",
"confidence": 0.95,
"box": [[x1,y1],[x2,y2],[x3,y3],[x4,y4]]
}
]
}
POST
/v1/rerank
Rerank documents by relevance to a query using BGE-reranker-v2-m3.
Parameters:
query — Search query stringdocuments — Array of document strings to ranktop_n — Number of top results to return (default: 5)
curl -X POST https://models.awesome.icu/v1/rerank -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"query": "machine learning", "documents": ["doc1", "doc2", "doc3"], "top_n": 3}'
GET
/v1/models
List all available models (OpenAI-compatible format).
curl https://models.awesome.icu/v1/models -H "Authorization: Bearer YOUR_API_KEY"