Hotpot API Documentation

Add Hotpot functionality to your app, website, or workflow with the Hotpot SaaS API.

Self-hosted solutions also exist for large organizations requiring maximum privacy and architectural control.

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

https://api.hotpot.ai/

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.

Status Codes
200
Success. Enjoy this amazing TikTok video. You deserve it.
400
Bad request. Invalid parameter values were provided.
401
Unauthorized. Make sure to include your API key in the Authorization HTTP header.
403
Forbidden. The API key you included in the Authorization header is not valid.
404
Missing endpoint. Make sure you use the correct URL path.
429
Rate limit or service quota exceeded. Make sure you have enough credits left in your account. Please employ exponential backoff before retrying.
500
Internal server errors. Please try again later or contact us if problems persist.

Art Maker

Create art with our AI image generator. Describe an image then let our AI interpret your words and transform them into art.

Endpoint
POST /make-art
Request Parameters
inputText
Required
Accepted Values: String.
The description of the graphic to be created. Please be specific and limit descriptions to 380 characters.
style
Optional
Accepted Values: See documentation for accepted styles.
See documentation for accepted styles
Request Example 
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
Response Properties
The resulting image URL.

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.

Endpoint
POST /remix-art
Request Parameters
contentImage
Required
Accepted Values: Image file.
The image to change.
styleImage
Required
Accepted Values: Image file.
The image whose style will be applied to the content (base) image.
focusContent
Required
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.
Request Example 
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
Response Properties
The resulting image (in binary format) after transferring style to the content image.

Background Remover

Remove the background from images with AI.

Endpoint
POST /remove-background
Request Parameters
image
Optional
Accepted Values: Image file.
The image from which to remove the background. Either this parameter or @imageUrl must be provided.
imageUrl
Optional
Accepted Values: string.
The public URL to an image from which to remove the background. Either this parameter or @image must be provided.
backgroundImage
Optional
Accepted Values: Image file.
The image to use as a new background.
backgroundUrl
Optional
Accepted Values: string.
The public URL to an image that will serve as the new background.
backgroundColor
Optional
Accepted Values: string.
The hex color code to serve as the new background.
returnAlpha
Optional
Accepted Values: true or false.
By default, the API returns an edited image with the background removed. If true, the API returns an alpha mask instead. This is useful for large images, as the alpha mask can reduce transfer time and bandwidth consumed. The alpha mask can be applied to the original image to produce an edited image on the client.
fileType
Optional
Accepted Values: jpg, png, or webp.
By default, the API returns PNG images. The API can also return JPG and WebP images. To compress images, use jpg or webp.
compressionFactor
Optional
Accepted Values: 10-100.
By default, the API performs no compression. If fileType is set to jpg or webp, the API uses a compression level of 85, which can be customized with this parameter. This value is ignored if fileType is not jpg or webp.
Request Example 
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
Response Properties
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.

Object Remover

Remove people, animals, trees, and other objects from images in seconds. Our AI is designed to recognize people, trees, and other common objects, naturally erasing them from the picture and leaving behind only the photograph you want.

Endpoint
POST /remove-object
Request Parameters
image
Required
Accepted Values: Image file.
The image to change.
mask
Required
Accepted Values: Mask image.
The image file defining the areas to erase. The image must be black and white, with white pixels indicating areas to erase.
Request Example 
curl -H 'Authorization: API_KEY_HERE' \
     -F '[email protected]/Users/porky/pig.jpg' \
     -F '[email protected]/Users/porky/mask.jpg' \
     -o '/Users/porky/funky-pig.jpg' \
     https://api.hotpot.ai/remove-object
Response Properties
The resulting image (in binary format) after erasing the areas indicated in the mask.

Object Detector

Detect people, cars, trucks, animals, e-commerce products, and other classes of common objects with AI. Contact us for the list of objects detectable.

Endpoint
POST /detect-object
Request Parameters
image
Required
Accepted Values: Image file.
The image to change.
Request Example 
curl -H 'Authorization: API_KEY_HERE' \
     -F '[email protected]/Users/porky/pig.jpg' \
     -o '/Users/porky/funky-pig.jpg' \
     https://api.hotpot.ai/detect-object
Response Properties
[{bbox: [x, y, width, height], class: 'person', score: 0.88888}, {bbox: [x, y, width, height], class: 'car', score: 0.823268}]

Color Generator

Generate color palettes or matching colors based on the given colors.

Endpoint
POST /generate-color
Request Parameters
colorList
Required
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.
Request Example 
curl -H 'Authorization: API_KEY_HERE' \
     -H "Content-Type: application/json" \
     --data '{"colorList": ["#6DADE0"]}' \
     https://api.hotpot.ai/generate-color
Response Properties
colorList
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.

Endpoint
POST /supersize-image
Request Parameters
image
Required
Accepted Values: Image file.
The image you want to enlarge.
sizeFactor
Required
Accepted Values: 2, 4.
The multiple by which to increase image resolution.
imageStyle
Required
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.
Request Example 
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
Response Properties
The resulting image (in 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.

Endpoint
POST /classify-image
Request Parameters
image
Required
Accepted Values: Image file.
The image to classify.
labelList
Required
Accepted Values: Comma-delimited string of categories to consider during classification.
Remove white space between commas
Request Example 
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
Response Properties
{ "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.

Endpoint
POST /colorize-picture
Request Parameters
image
Required
Accepted Values: Image file.
The black and white image which you want to colorize.
renderFactor
Required
Accepted Values: 0 - 50.
The colorization factor, as described on the DeOldify GitHub.
Request Example 
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
Response Properties
The resulting image (in binary format) after colorization.

Picture Restorer

Restore pictures with AI by removing scratches, sharpening colors, and enhancing faces. Repairs color and black & white photos.

Endpoint
POST /restore-picture
Request Parameters
image
Required
Accepted Values: Image file.
The image you want to restore.
withScratch
Required
Accepted Values: true or false.
Does the image have scratches?
Request Example 
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
Response Properties
The resulting image (in binary format) after restoration.

Stable Diffusion Basic

Use the basic version of Stable Diffusion

Endpoint
POST /stable-diffusion-basic
Request Parameters
inputText
Required
Accepted Values: String.
The text to turn into an image.
Request Example 
curl -H 'Authorization: API_KEY_HERE' \
     -F '[email protected]/Users/porky/pig.jpg' \
     -o '/Users/porky/funky-pig.jpg' \
     https://api.hotpot.ai/stable-diffusion-basic
Response Properties
The resulting image as a binary file.