Skip to main content
POST
Generate synthetic image reference data

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
count
string

Number of image records to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

method
enum<string>

Image generation method. Defaults to profile.

Available options:
profile,
avatar,
avatarGitHub,
personPortrait,
url,
urlLoremFlickr,
urlPicsumPhotos,
dataUri
Example:

"profile"

width
string

Image width for image URL or data URI output. Range: 1-3999.

Pattern: ^[1-9]\d*$
Example:

"640"

height
string

Image height for image URL or data URI output. Range: 1-3999.

Pattern: ^[1-9]\d*$
Example:

"480"

category
string

Category segment for categorized image URL output.

Pattern: ^[A-Za-z0-9_-]{1,50}$
Example:

"nature"

grayscale
enum<string>

Generate grayscale output where supported.

Available options:
true,
false
Example:

"false"

blur
string

Blur amount for supported image URL output. Range: 0-10.

Pattern: ^\d+$
Example:

"4"

color
string

Color for data URI output. Use a CSS color name or hex color value.

Pattern: ^#?[0-9A-Fa-f]{3,8}$|^[A-Za-z]+$
Example:

"#336699"

dataUriType
enum<string>

Data URI encoding type.

Available options:
svg-uri,
svg-base64
Example:

"svg-uri"

sex
enum<string>

Portrait sex option for person portrait output.

Available options:
female,
male
Example:

"female"

size
enum<string>

Portrait image size in pixels.

Available options:
32,
64,
128,
256,
512
Example:

"128"

Response

Successfully generated image reference data

status
enum<string>
required
Available options:
success
data
object
required
performance
object