API documentation
This is documentation for API of ximilar.com
and vize.ai
services for developers. Before using the API, please register/create account through Ximilar App. After registration you will obtain the authentication token which you can use for calling various Ximilar services. We use REST API and both requests and responses are formatted as JSON. Most of the services are free to use for testing purposes (see pricing plans).
Status Page
We try to be always up. You can monitor uptime of our API and application on our status page. This is also the place to report system maintenance: status.ximilar.com
Python Library
If you are using Python in your project and do not want to play with requests, you can query our API with our library. Our library is on gitlab: gitlab.com/ximilar-public/ximilar-client
At this point, this library covers Recognition (previously Vize.ai), Detection , Generic Tagging, Fashion Tagging, Dominant Colors and Photo and Product Similarity.
Questions about API or APP?
If you have any problems or questions about API please write to tech@ximilar.com. We wrote our tips on our blog and we have also video tutorials for you.
Quickstart
Ximilar Services
- Image Classification & Regression - train your own ML models for image categorization/tagging or regression
- Object Detection - train models for object detection (with object position)
- Flows - chain recognition and detection models
- Fashion Tagging - get categories and tags for apparel images
- Home Decor Tagging - get categories and tags for furniture & home decor product images
- Generic Tagging - get tags for generic photos
- Dominant Colors - get dominant colors of generic or product photos
- Person Detection & Recognition - detect faces in photos
- Collectibles Recognition - detect and analyze collector's items
- Card Grading - pre-grade cards of TCGs or Sport cards
- OCR - detect & read texts, optionally analyze them with ChatGPT model
- Product Description Generation - generate description and titles for fashion products, real estate and more.
- Basics of Search API - basic methods for visual search (similarity) in image collections
- Photo Similarity & Text Search - search on generic and stock photos collection with images or text
- Fashion Search - fashion detection, tagging and visual search in one service
- Custom Similarity - define & train your own model of similarity for visual search
- Image Matching - identify duplicate or near-duplicate images
- Furniture & Home Decor Search - home decor & furniture detection, tagging and visual search in one serve
- Upscaler - upscale images with super-resolution model
- Remove Background - remove/distinguish background for images with some dominant item or object