Integrate Hotpot functionality into your app, website, or company workflow with the Hotpot API.
Self-hosted options are available for companies requiring on-premise solutions for privacy or regulatory reasons.
The API is based on REST.
Access to the Hotpot API is available upon request.
Demos
The API endpoints below power the Hotpot.ai AI services and graphic platform. View the Tools page for product demos of the AI service.
View code examples on our Github repo.
Partners
The Hotpot API is designed for enterprise-level scalability and reliability, suitable for bursty workloads or sustained high-volume traffic.
To ensure we adopt best practices and state-of-the-art technologies, Hotpot is proud to partner with leaders in cloud infrastructure and machine learning.
See partners.
Authentication
All API requests require authentication. To authenticate to the API, pass the Authorization
HTTP header with the valid API key on each request. You can view and manage API credentials from your account.
Authorization: yMHw4UidZM1Hha82AZtMjI50bYCfC3sdX7vvB
Base URL
Credits
You can view the number of API credits left for any given service in the X-API-Credits-Left
HTTP response header.
Responses
The Hotpot API uses standard HTTP status codes to communicate the result of API operations.
Bad request. Invalid parameter values were provided.
Unauthorized. Make sure to include your API key in the Authorization
HTTP header.
Forbidden. The API key you included in the Authorization
header is not valid.
Missing endpoint. Make sure you use the correct URL path.
Rate limit or service quota exceeded. Make sure you have enough credits left in your account. Please employ exponential backoff before retrying.
Internal server errors. Please try again later or
contact us if problems persist.
Art Maker Beta
Create art with our AI image generator. Describe an image then let our AI interpret your words and transform them into art.
Accepted Values: String.
The description of the graphic to be created. Please be specific and limit descriptions to 280 characters.
Accepted Values: See documentation for accepted styles.
See documentation for accepted styles
curl -H 'Authorization: API_KEY_HERE' \
-F 'inputText=A pig in the style of Starry Night by Vincent Van Gogh' \
-F 'outputWidth=256' \
-F 'numIterations=400' \
https://api.hotpot.ai/make-art-beta
Art Personalizer
Create personalized art with AI. Our deep learning model uses Neural Style Transfer to offer arbitrary artistic style transfer, allowing you to extract the style from one image and apply it to another. Most image style transfer models are trained on fixed, pre-defined styles. Ours is designed for flexibility and can accommodate styles not encountered during the training phase.
Accepted Values: Image file.
The image to change.
Accepted Values: Image file.
The image whose style will be applied to the content (base) image.
Accepted Values: true
or false
.
Set to true
if you want the result to resemble the base image (contentImage
). Setting it to false
will result in a more cartoonish image.
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-F '[email protected]/Users/porky/funky.jpg' \
-F 'focusContent=true' \
-o '/Users/porky/funky-pig.jpg' \
https://api.hotpot.ai/remix-art
The resulting image (in a binary format) after transferring style to the content image.
Background Remover
Remove the background from images with AI.
Accepted Values: Image file.
The image from which to remove the background. Either this parameter or @imageUrl must be provided.
Accepted Values: string.
The public URL to an image from which to remove the background. Either this parameter or @image must be provided.
Accepted Values: string.
The image to use as a new background.
Accepted Values: string.
The public URL to an image that will serve as the new background.
Accepted Values: string.
The hex color code to serve as the new background.
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-o '/Users/porky/large-pig.jpg' \
https://api.hotpot.ai/remove-background
The image (in binary format) after removing the background from the input image. The default background is transparent. By default, the result has a transparent background. However, if a background value is provided, the result will be superimposed on this background. Only one background value can be submitted.
Color Generator
Generate color palettes or matching colors based on the given colors.
Accepted Values: Array of 0-4 strings, each representing a color in hexadecimal format.
These colors guide our machine learning model, which generate ideas to match the provided colors. If the array is empty, our AI creates suggetions based on a random color.
curl -H 'Authorization: API_KEY_HERE' \
-H "Content-Type: application/json" \
--data '{"colorList": ["#6DADE0"]}' \
https://api.hotpot.ai/generate-color
Array of hexadecimal colors.
Graphic Enlarger
Enlarge pictures, game assets, textures, and other graphics in seconds. This AI upscaler can create images of higher resolution without losing quality and is optimized for e-commerce stores, app graphics, and photo prints.
Accepted Values: Image file.
The image you want to enlarge.
Accepted Values: 2
, 4
.
The multiple by which to increase image resolution.
Accepted Values: default
, anime
.
The style that best describes the image to modify. Our AI accounts for different styles when extrapolating from an input image to output images of higher resolution.
noiseCancellationFactor
Required
Accepted Values: 0
, 1
, 2
.
The level of noise cancellation applied.
0 means no noise cancellation.
1 means low noise cancellation.
2 means medium noise cancellation.
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-F 'sizeFactor=2' \
-F 'imageStyle=default' \
-F 'noiseCancellationFactor=0' \
-o '/Users/porky/big-pig.jpg' \
https://api.hotpot.ai/supersize-image
The resulting image (in a binary format) after enlarging it.
Image Classifier
Categorize and tag images with the latest AI technology. Normal image classifiers require pre-defined categories or extensive training for custom categories. Our classifier can tag images based on custom categories -- without training. Optimized for e-commerce and media companies.
Accepted Values: Image file.
The image to classify.
Accepted Values: Comma-delimited string of categories to consider during classification.
Remove white space between commas
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-F 'labelList=shirt,jeans,blue,white,short-sleeve' \
https://api.hotpot.ai/classify-image
{ "shirt": 0.98, "jeans": 0.01, "blue": 0.95, "white": 0.02, "short-sleeve": 0.88 }
Picture Colorizer
Colorize black and white pictures with AI.
Accepted Values: Image file.
The black and white image which you want to colorize.
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-F 'renderFactor=20' \
-o '/Users/porky/large-pig.jpg' \
https://api.hotpot.ai/colorize-picture
The resulting image (in a binary format) after colorization.
Picture Restorer
Restore pictures with AI by removing scratches, sharpening colors, and enhancing faces. Repairs color and black & white photos.
Accepted Values: Image file.
The image you want to restore.
Accepted Values: true
or false
.
Does the image have scratches?
curl -H 'Authorization: API_KEY_HERE' \
-F '[email protected]/Users/porky/pig.jpg' \
-F 'withScratch=true' \
-o '/Users/porky/restored-pig.jpg' \
https://api.hotpot.ai/restore-picture
The resulting image (in a binary format) after restoration.