Image & Text generation

The various methods for Image and Text Generation Settings are listed below:

Generate image from prompt
Generate text from prompt
Generative fill (outpaint)
Background removal
Trim and remove background

Generate Image from Prompt

Generates an image from a text prompt using the GenAI service.

Parameters

Field	Data Type	Requirement	Description
prompt	string	Mandatory	Text prompt for image generation
width	integer	Mandatory	Width of the generated image in pixels
height	integer	Mandatory	Height of the generated image in pixels

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/imageGen
Copy

Request Body

JSON
    
 
{  "prompt": "A modern product banner for a sports brand",  "width": 728,  "height": 90}
Copy

Sample Response

Proxied JSON response from the GenAI service.

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/img-001.png"}
Copy

Generate Text from Prompt

Generates text (e.g. headlines, copy) from a text prompt.

Parameters

Field	Data Type	Requirement	Description
prompt	string	Mandatory	Text prompt for image generation

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/textGen
Copy

Request Body

JSON
    
 
{  "prompt": "Write a catchy headline for a summer sale"}
Copy

Sample Response

JSON
    
 
{  "text": "Beat the Heat — Summer Sale Up to 50% Off!"}
Copy

Generative fill (outpaint)

Extends or fills an image using generative AI (outpainting / generative fill).

Parameters

Field	Data Type	Requirement	Description
image	string	Mandatory	Image URL or base64-encoded image data
width	integer	Mandatory	Target width of the output image
height	integer	Mandatory	Target height of the output image
prompt	string	Optional	Optional text hint to guide the fill

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/outpaint
Copy

Request Body

JSON
    
 
{  "image": "https://cdn.example.com/original.jpg",  "width": 300,  "height": 250,  "prompt": "Extend the background with a blurred outdoor scene"}
Copy

Sample Response

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/outpaint-001.png"}
Copy

Background Removal

Removes the background from an image.

Parameters

Field	Data Type	Requirement	Description
image	string	Mandatory	Image URL or base64-encoded image data

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/removeBg
Copy

Request Body

JSON
    
 
{  "image": "https://cdn.example.com/product.jpg"}
Copy

Sample Response

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/no-bg-001.png"}
Copy

Trim and Remove Background

Trims whitespace/padding and removes the background from an image.

Parameters

Field	Data Type	Requirement	Description
image	string	Mandatory	Image URL or base64-encoded image data

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/trimRemoveBg
Copy

Request Body

JSON
    
 
{  "image": "https://cdn.example.com/product-padded.jpg"}
Copy

Sample Response

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/trimmed-001.png"}
Copy

Feed Processing

Batch generative Fill

Runs generative fill on an entire feed column asynchronously.

Parameters

Field	Data Type	Requirement	Description
userEmail	string	Optional	Email to notify on completion
adId	integer	Mandatory	Ad ID
adUnitId	integer	Mandatory	Ad unit ID
dataServiceId	integer	Mandatory	Data service (feed) ID.
column	string	Mandatory	Feed column name containing image URLs
assetId	string	Mandatory	Asset identifier
assetProperty	string	Mandatory	Asset property name (e.g. `jvx_image`)
filter	array of `{key: value}`	Optional	Row filters to scope the batch
width	integer	Mandatory	Target width of the output image
height	integer	Mandatory	Target height of the output image

advId is injected server-side from the authenticated account.

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/processFeed/outpaint
Copy

Request Body

JSON
    
 
{  "userEmail": "user@example.com",  "adId": 200,  "adUnitId": 2000,  "dataServiceId": 1,  "column": "Image Url",  "assetId": "asset-123",  "assetProperty": "jvx_image",  "filter": [{ "category": "shoes" }],  "width": 300,  "height": 250}
Copy

Sample Response

Proxied JSON response with job status.

JSON
    
 
{  "jobId": "job-abc123",  "status": "INITIATED"}
Copy

Last updated on

Was this page helpful?