Start Campaign Image Edit Job

Start an asynchronous job to generate edited image variations for a campaign asset.

post/api/campaigns/images/edit-image/job

Request

Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
URL: https://api.usepomo.ai/api/campaigns/images/edit-image/job
Auth: HTTP bearer

Request body

image_urlstring required

edit_promptstring required

num_variationsinteger

product_image_urlstring nullable

reference_image_urlsstring[]

logo_image_urlstring nullable

campaign_idstring nullable

campaign_typestring nullable

ad_idstring nullable

idea_numberinteger nullable

variationinteger nullable

use_company_styleboolean

request_identitystring uuid nullable

requested_image_size'1K' | '2K' | '4K' nullable

required_textstring[] nullable

Response

Successful Response

job_idstring required

Unique job identifier

statusstring required

Initial job status (typically 'running')

stream_urlstring required

SSE endpoint for real-time progress

poll_urlstring required

HTTP endpoint for polling status

Example response

{
  "job_id": "987fcdeb-51a2-43f7-9876-543210987654",
  "poll_url": "/api/chat/agentic/jobs/987fcdeb-51a2-43f7-9876-543210987654",
  "status": "running",
  "stream_url": "/api/chat/agentic/jobs/987fcdeb-51a2-43f7-9876-543210987654/stream"
}

Changes

No recorded changes to this operation across all 1 revision of this API.