Skip to main content
POST
/
generic
/
data
/
generate
/
image
Generate synthetic image reference data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=profile \
  --data width=640 \
  --data height=480 \
  --data category=nature \
  --data grayscale=false \
  --data blur=4 \
  --data 'color=#336699' \
  --data dataUriType=svg-uri \
  --data sex=female \
  --data size=128
{
  "status": "success",
  "data": {
    "images": [
      {
        "method": "profile",
        "value": "https://images.example.com/seed/example/640/480",
        "url": "https://images.example.com/seed/example/640/480",
        "avatar": "https://images.example.com/avatar/12345",
        "avatarGitHub": "https://avatars.example.com/u/12345",
        "personPortrait": "https://images.example.com/portraits/female/128/12.jpg",
        "urlLoremFlickr": "https://images.example.com/640/480/nature?lock=12345",
        "urlPicsumPhotos": "https://images.example.com/seed/example/640/480?grayscale&blur=4",
        "dataUri": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%3E",
        "width": 640,
        "height": 480,
        "category": "nature",
        "grayscale": true,
        "blur": 4,
        "color": "#336699",
        "dataUriType": "svg-uri",
        "sex": "female",
        "size": 128
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "profile"
  },
  "performance": {
    "generationTime": 3,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

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