Jivox API Documentation
v1.0
GenAI & Template Generation
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Image & Text generation
Copy Markdown
Open in ChatGPT
Open in Claude
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/imageGenRequest Body
JSON
{ "prompt": "A modern product banner for a sports brand", "width": 728, "height": 90}Sample Response
Proxied JSON response from the GenAI service.
JSON
{ "imageUrl": "https://cdn.example.com/generated/img-001.png"}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/textGenRequest Body
JSON
{ "prompt": "Write a catchy headline for a summer sale"}Sample Response
JSON
{ "text": "Beat the Heat — Summer Sale Up to 50% Off!"}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/outpaintRequest Body
JSON
{ "image": "https://cdn.example.com/original.jpg", "width": 300, "height": 250, "prompt": "Extend the background with a blurred outdoor scene"}Sample Response
JSON
{ "imageUrl": "https://cdn.example.com/generated/outpaint-001.png"}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/removeBgRequest Body
JSON
{ "image": "https://cdn.example.com/product.jpg"}Sample Response
JSON
{ "imageUrl": "https://cdn.example.com/generated/no-bg-001.png"}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/trimRemoveBgRequest Body
JSON
{ "image": "https://cdn.example.com/product-padded.jpg"}Sample Response
JSON
{ "imageUrl": "https://cdn.example.com/generated/trimmed-001.png"}Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Last updated on
Was this page helpful?
Next to read:
Feed ProcessingDiscard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message