Hotpot API Documentation

The Hotpot API offers the ability to programmatically access Hotpot functionality.

The API is based on REST.

The Hotpot API is currently in open beta. Please contact us to request access.

Demos

The API endpoints listed here power the AI services and graphic platform on Hotpot.ai. You can see product demos of the AI services from the Tools page.

Authentication

All API requests require authentication. To authenticate to the API, pass the client_secret parameter to each request.

You can view and manage API credentials from your account.

Base URL

https://api.hotpot.ai/

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 or a required parameter was missing.
401
Unauthorized. The request used an invalid API key.
404
Missing endpoint. The requested API endpoint was not found.
429
Rate limit exceeded. Please employ exponential backoff before retrying.
500, 503
Hotpot server errors.

In the event of a 4xx or 5xx error, the API will supply the response listed below. For successful invocations, the API will provide a response as described in the relevant endpoint section.

Error Response Body
{
  "code": 429,
  "message": "Rate limit exceeded"
}
Error Response Properties
code
The status code of the error.
message
Details on the error.

Graphic Creator

Create App Store screenshots, Instagram posts, e-commerce ads, game assets, and other graphics programmatically by customizing Hotpot.ai templates.

Endpoint
POST /v1a/create-graphic
Request Parameters
designID
Required
The ID of the Hotpot template to customize.
textList
Optional
Accepted Values: Array of strings.
The text to use in the Hotpot graphic. Text replacement occurs sequentially, that is, the first array element replaces the first text item in the Hotpot template, the second array element replaces the second text item, etc.
screenshotList
Optional
Accepted Values: Array of Base64 image.
The screenshots to use in the Hotpot graphic. Screenshot replacement occurs sequentially, that is, the first array element replaces the first screenshot item in the Hotpot template, the second array element replaces the second screenshot item, etc.
imageList
Optional
Accepted Values: Array of Base64 image.
The images to use in the Hotpot graphic. Image replacement occurs sequentially, that is, the first array element replaces the first image item in the Hotpot template, the second array element replaces the second image item, etc.
Response Properties
base64Image
Base64 image. The resulting image after customizing the Hotpot.ai template with the parameter values.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}

Art Remixer

Make AI art by mixing pictures and paintings. 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 /v1a/remix-art
Request Parameters
base64ContentImage
Required
Accepted Values: Base64 image.
The image to modify.
base64StyleImage
Required
Accepted Values: Base64 image.
The image whose style to emulate.
Response Properties
base64Image
Base64 image. The resulting image after transferring style to the content image.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}

Image Supersizer

Enlarge graphics and increase image resolution without losing quality.

Endpoint
POST /v1a/supersize-image
Request Parameters
base64Image
Required
Accepted Values: Base64 image.
The image to modify.
sizeFactor
Required
Accepted Values: 2, 4, 8, 16.
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.
Response Properties
base64Image
Base64 image. The resulting image after extrapolating the input image to a higher resolution.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}

File Translator

Translate iOS, Android, YouTube, and other localization files with AI.

Endpoint
POST /v1a/translate-file
Request Parameters
text
Required
Accepted Values: String array.
The text to translate, organized as an array of strings.
type
Required
Accepted Values: plaintext, localizable.strings, strings.xml, json, resx, html, srt.
The format of the text submitted for translation.
sourceLanaguageCode
Required
Accepted Values: See code list.
The language to translate from, represented by its Microsoft Translator language code
targetLanguageCode
Required
Accepted Values: See code list.
The language to translate to, represented by its Microsoft Translator language code
Response Properties
translatedText
String array. The input string array after translation to the target language.
Response Example
{
  "translatedText": [
    "translatedText1",
    "translatedText2",
    "translatedText3"
  ]
}

Background Remover

Remove the background from images with AI.

Endpoint
POST /v1a/remove-background
Request Parameters
base64Image
Required
Accepted Values: Base64 image.
The image from which to remove the background.
Response Properties
base64Image
Base64 image. The resulting image after removing the background from the input image.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}

Picture Colorizer

Colorize black and white pictures with AI.

Endpoint
POST /v1a/colorize-picture
Request Parameters
base64Image
Required
Accepted Values: Base64 image.
The black and white image to colorize.
renderFactor
Required
Accepted Values: 0 - 50.
The colorization factor, as described on the DeOldify GitHub.
Response Properties
base64Image
Base64 image. The resulting image after colorizing the input picture.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}

Color Generator

Generate color palettes or matching colors based on a baseline color.

Endpoint
POST /v1a/generate-color
Request Parameters
color0
Required
Accepted Values: RGB color, represented as an array of 3 integers.
The color to use as the baseline for color suggestions.
base64Image
Optional
Accepted Values: Base64 image.
The most dominant color from this image will serve as the baseline for color suggestions.
Response Properties
color0
Array of three integers. RGB color of the first color in the suggested palette.
color1
Array of three integers. RGB color of the second color in the suggested palette.
color2
Array of three integers. RGB color of the third color in the suggested palette.
color3
Array of three integers. RGB color of the fourth color in the suggested palette.
color4
Array of three integers. RGB color of the fifth color in the suggested palette.
Response Example
{
  "color0": [255, 255, 255], 
  "color1": [255, 255, 255], 
  "color2": [255, 255, 255], 
  "color3": [255, 255, 255], 
  "color4": [255, 255, 255]
}

Color From Picture

Extract the primary colors from a picture.

Endpoint
POST /v1a/color-from-picture
Request Parameters
base64Image
Required
Accepted Values: Base64 image.
The picture or graphic from which to extract colors.
Response Properties
color0
Array of three integers. RGB color of the most dominant color from the input picture.
color1
Array of three integers. RGB color of the second most dominant color from the input picture.
color2
Array of three integers. RGB color of the third most dominant color from the input picture.
color3
Array of three integers. RGB color of the fourth most dominant color from the input picture.
color4
Array of three integers. RGB color of the fifth most dominant color from the input picture.
Response Example
{
  "color0": [255, 255, 255], 
  "color1": [255, 255, 255], 
  "color2": [255, 255, 255], 
  "color3": [255, 255, 255], 
  "color4": [255, 255, 255]
}

Face Blurrer

Blur faces, text, and other sensitive information in a picture.

Endpoint
POST /v1a/blur-face
Request Parameters
base64Image
Required
Accepted Values: Base64 image.
The image to blur.
shouldBlurText
Required
Accepted Values: true or false.
True to blur text, false otherise.
Response Properties
base64Image
Base64 image. The resulting image after redaction.
Response Example
{
  "base64Image": "aHR0cHM6Ly9ob3Rwb3QuYWkvaG90cG90Y2hh"
}