Oyyi Documentation
Welcome to the Oyyi documentation. This guide will help you integrate our powerful media manipulation capabilities into your applications.
No authentication required! Our API is completely free to use with no usage limits or hidden costs.
Base URL
All API requests should be made to the following base URL:
https://oyyi.xyz/api
Request Format
Our API accepts multipart/form-data requests for endpoints that require file uploads, which includes most of our image processing endpoints.
Response Format
Responses are typically returned as binary data (the processed image) or as JSON for metadata and error responses.
Error Handling
When an error occurs, the API will return a JSON response with an error message and appropriate HTTP status code:
{
"error": "Invalid file format. Supported formats: JPEG, PNG, WebP, BMP, TIFF",
"status_code": 400
}
API Categories
The Oyyi provides the following categories of endpoints:
Basic Operations
Resize, crop, rotate, flip, convert, and compress images.
Color Adjustments
Apply grayscale, adjust contrast, threshold, isolate channels, and more.
Filters & Effects
Apply blur, sharpen, edge detection, cartoon effects, and more.
Composition
Add watermarks, draw shapes, overlay images, and more.
Analysis
Extract metadata, dominant colors, generate histograms, and more.
Utility
Convert images to and from base64 encoding.
Supported Image Formats
The Oyyi supports the following media formats:
- JPEG - Best for photographs and complex images with many colors
- PNG - Best for graphics with transparency, screenshots, and images with text
- WebP - Modern format with excellent compression and quality
- BMP - Uncompressed format, larger file sizes but no quality loss
- TIFF - Versatile format often used in professional photography and printing
Performance
Our API is optimized for performance using Numba and Cython acceleration. Most operations complete in under 100ms, with many taking less than 50ms. We can handle thousands of requests per minute with our distributed processing architecture.
Getting Started
To get started with the Oyyi, select an endpoint category from the sidebar to view detailed documentation, including required parameters and example requests.