Feed Processing

AI Tools

The various methods for Feed Processing Settings are listed below:

  1. Batch generative Fill

  2. Batch Background Removal

  3. Batch Trim and Remove Background

  4. Cancel Feed Transformation

  5. Get Feed Transformation Progress

  6. Get Feed Transformation Progress (row)

  7. Get GenAI Feed Progress (Ad)

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

Info

advId is injected server-side from the authenticated account.

Sample Request

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

Request Body

{ "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 }

Sample Response

Proxied JSON response with job status.

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

Batch Background Removal

Runs background removal 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

filter

array of {key: value}

Optional

Row filters to scope the batch

Info

advId is injected server-side from the authenticated account

Sample Request

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

Request Body

{ "userEmail": "user@example.com", "adId": 200, "adUnitId": 2000, "dataServiceId": 1, "column": "Image Url", "assetId": "asset-123", "assetProperty": "jvx_image" }

Sample Response

{ "jobId": "job-def456", "status": "INITIATED" }

Batch Trim and Remove Background

Runs trim + background removal on an entire feed column asynchronously. Uses the same request body as Batch background removal

Sample Request

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

Cancel Feed Transformation

Cancels an in-progress batch feed transformation job

Parameters

Field

Data Type

Requirement

Description

adId

integer

Mandatory

Ad ID

adUnitId

integer

Mandatory

Ad unit ID

Info

advId is injected server-side.

Sample Request

POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/processFeed/terminate

Request Body

{ "adId": 200, "adUnitId": 2000 }

Sample Response

{ "status": "CANCELLED", "message": "Feed transformation job cancelled" }

Get Feed Transformation Progress

Returns the progress of an in-progress feed transformation job.

Parameters

Field

Data Type

Requirement

Description

adId

integer

Mandatory

Ad ID

adUnitId

integer

Mandatory

Ad unit ID

Info

advId is injected server-side.

Sample Request

POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/processFeed/monitor

Request Body

{ "adId": 200, "adUnitId": 2000 }

Sample Response

{ "status": "PROCESSING", "progress": 65, "totalRows": 100, "processedRows": 65 }

Get Feed Transformation Progress (row)

Returns the transformation progress for a specific feed row.

Parameters

Field

Data Type

Requirement

Description

adId

integer

Mandatory

Ad ID

adUnitId

integer

Mandatory

Ad unit ID

dataServiceId

integer

Mandatory

Data service (feed) ID

column

string

Mandatory

Feed column name

transformation

string

Mandatory

Transformation type applied

assetProperty

string

Mandatory

Asset property name

assetId

string

Mandatory

Asset identifier

versionId

integer

Mandatory

Version ID of the transformation

Info

advId is injected server-side.

Sample Request

POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/processFeed/monitorRow

Request Body

{ "adId": 200, "adUnitId": 2000, "dataServiceId": 1, "column": "Image Url", "transformation": "removeBg", "assetProperty": "jvx_image", "assetId": "asset-123", "versionId": 3 }

Sample Response

{ "status": "COMPLETED", "outputUrl": "https://cdn.example.com/generated/row-001.png" }

Get GenAI Feed Progress (Ad)

Returns the GenAI feed transformation progress for all ad units (or a specific one) of an ad.

Path Parameters

Field

Data Type

Requirement

Description

accountId

string

Mandatory

Account ID

adIdx

integer

Mandatory

Ad index

Query Parameters

Field

Data Type

Requirement

Default

Description

adUnitIdx

integer

Optional

0

If provided, returns progress for that ad unit only.

Sample Request

GET https://jivoxapis.api.jivox.com/v2/accounts/:accountId/ad/:adIdx/genAIFeedProgress?adUnitIdx=2000

Sample Response

If adUnitIdx is provided, returns a single progress object; otherwise returns a list.

[ { "adUnitIdx": 2000, "status": "COMPLETED", "progress": 100 } ]


Next to read:
Template GenAI
null
On This Page
Feed ProcessingBatch generative FillBatch Background RemovalBatch Trim and Remove BackgroundCancel Feed TransformationGet Feed Transformation ProgressGet Feed Transformation Progress (row)Get GenAI Feed Progress (Ad)