Placewise 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:UserToken

Generates an image based on text prompt.

Body Parameters

Parameter	Type	Required?	Description
prompt	String	yes	Image generation prompt.
model_type	String	no (default "small")	Model type, one of: "small", "medium", "large". Larger models have higher quality, longer generation time, and higher cost.
aspect_ratio	String	no (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_size	String	no (default "thumbnail")	Image size, one of: "thumbnail" (256 px), "small" (512 px), "medium" (1024 px), "large" (1440 px).
creativity	Integer	no (default 2)	Variability and creativity of image generation. Only used in "medium" and "large" models.
photorealistic	Boolean	no (default false)	If true, generate photorealistic images. Only used in "large" model.
random_seed	Integer	no (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

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params multipart/form-data

prompt

string

optional

Image generation prompt.

Example:

Minimalistic cheesecake cartoon image

model_type

string

optional

Model type, one of: "small", "medium", "large". Larger models have higher quality, longer generation time, and higher cost.

Example:

small

aspect_ratio

string

optional

Image aspect ratio, one of: "1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "16:9", "9:16".

Example:

1:1

image_size

string

optional

Image size, one of: "thumbnail" (256 px), "small" (512 px), "medium" (1024 px), "large" (1440 px).

Example:

thumbnail

creativity

integer

optional

Variability and creativity of image generation. Only used in "medium" and "large" models.

Example:

photorealistic

boolean

optional

If true, generate photorealistic images. Only used in "large" model.

Example:

false

random_seed

integer

optional

If set, it results in deterministic generation.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/general/generate_image' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--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

image_generation_task

object

required

integer

required

Task ID

Example

{
  "image_generation_task": {
    "id": 0
  }
}

Modified at 2025-04-14 10:25:30

Recommend sending time v2

Generate Text

Generate Image

Body Parameters#

Example#

Request

Request samples

Responses

Body Parameters

Example