Skip to main content
POST
Generate test images from a brand image configuration

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Brand image test request

Request body for testing a brand image configuration

companyId
string
required

Company ID

image
object
required

Brand image configuration to test — same shape as the save payload image object; does not need to be saved first

contentId
string

Existing content ID to test with (its title, body, and type are used; overrides title/text/contentType)

title
string

Sample content title

text
string

Sample content body text

contentType
string

Content type used for image sizing (default blog_post)

Response

Generated test images

Generated test images

images
object[]

Generated test images: {url, width, height, prompt}