Image & Text generation

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

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
    
xxxxxxxxxx
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/imageGen
Copy

Request Body

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

Sample Response

Proxied JSON response from the GenAI service.

JSON
    
xxxxxxxxxx
 
{  "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
    
xxxxxxxxxx
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/textGen
Copy

Request Body

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

Sample Response

JSON
    
xxxxxxxxxx
 
{  "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
    
xxxxxxxxxx
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/outpaint
Copy

Request Body

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

Sample Response

JSON
    
xxxxxxxxxx
 
{  "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
    
xxxxxxxxxx
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/removeBg
Copy

Request Body

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

Sample Response

JSON
    
xxxxxxxxxx
 
{  "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
    
xxxxxxxxxx
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/trimRemoveBg
Copy

Request Body

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

Sample Response

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

Last updated on

Was this page helpful?