Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
  1. ML API
  • Introduction
  • Sendings
    • Deprecated
      • Predict Sending KPI v1
      • Explain Sending KPI Prediction v1
      • Predict Sending KPI In Date Range v1
      • Explain Sending Text KPI Prediction v1
    • Predict Sending Text Popularity
      POST
    • Explain Sending Text Popularity Prediction
      POST
    • Predict Sending Time Series Popularity
      POST
    • Explain Sending Time Series Popularity Prediction
      POST
    • Predict Sending Popularity
      POST
    • Predict Bulk Sending Popularity
      POST
    • Explain Sending Popularity Prediction
      POST
    • Recommend sending time
      POST
  • Detect receipt fraud
    POST
  • Predict item classes
    POST
  • Generate Image
    POST
  • Generate Image Caption
    POST
  • Generate Text
    POST
  • Generate Sending Text
    POST
  1. ML API

Generate Image

POST
https://api.mpc.dev.placewise.com/v1/ml/general/generate_image
API Permit:ML:ImageGeneration:Post
API Context:Loyalty Club
Authorizations:User
Generates an image based on text prompt.

Body Parameters#

ParameterTypeRequired?Description
promptStringyesImage generation prompt.
model_typeStringno (default "small")Model type, one of: "small", "medium", "large". Larger models have higher quality, longer generation time, and higher cost.
aspect_ratioStringno (default "1:1")Image aspect ratio, one of: "1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "16:9", "9:16".
image_sizeStringno (default "thumbnail")Image size, one of: "thumbnail" (256 px), "small" (512 px), "medium" (1024 px), "large" (1440 px).
creativityIntegerno (default 2)Variability and creativity of image generation. Only used in "medium" and "large" models.
photorealisticBooleanno (default false)If true, generate photorealistic images. Only used in "large" model.
random_seedIntegerno (default null)If set, it results in deterministic generation.
Warning: for model size "small", image size must be "thumbnail" or "medium"'

Example#

When successful, returns:
{
    'image_generation_task': {
        'id': 1
    }
}

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/general/generate_image' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'Authorization: Bearer ' \
--form 'prompt="Minimalistic cheesecake cartoon image"' \
--form 'model_type="small"' \
--form 'aspect_ratio="1:1"' \
--form 'image_size="thumbnail"' \
--form 'creativity="2"' \
--form 'photorealistic="false"' \
--form 'random_seed="1"'

Responses

🟢200Success
application/json
Body

Example
{
    "image_generation_task": {
        "id": 0
    }
}
Previous
Predict item classes
Next
Generate Image Caption
Built with