Skip to main content
POST
Create Ai Generated Image

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

company_id
integer
required

Company ID

Body

application/json
prompt
string
required

Text prompt for image generation

Required string length: 3 - 1000
size
enum<string>
default:square_1_1

Image aspect ratio (square_1_1, classic_4_3, traditional_3_4, widescreen_16_9, social_story_9_16)

Available options:
square_1_1,
classic_4_3,
traditional_3_4,
widescreen_16_9,
social_story_9_16
guidance_scale
number
default:1

How closely to follow the prompt (0.0-2.0)

Required range: 0 <= x <= 2
filter_nsfw
boolean
default:true

Filter NSFW content

style
string | null

Optional style modifier (e.g., 'anime', 'photo', 'digital-art', '3d', 'painting')

negative_prompt
string | null

What to avoid in the image (min 3 chars)

Minimum string length: 3
seed
integer | null

Seed for reproducibility (0-1000000)

Required range: 0 <= x <= 1000000
tags
string[]

Optional tags for the generated image

alt_text
string | null

Optional alt text for accessibility

Response

Successful Response

id
integer
required
filename
string
required
url
string
required
file_size
integer
required
mime_type
string
required
source_type
enum<string>
required
Available options:
upload,
stock,
ai_generated
date_added
string<date-time>
required
date_updated
string<date-time>
required
width
integer | null
height
integer | null
external_id
string | null
external_metadata
External Metadata · object | null
tags
string[]
alt_text
string | null