guided-workflow

Finalize Video Campaign

Start video generation for a draft video campaign (HITL finalize step).

post/api/guided-workflow/campaigns/{campaign_id}/generate-video

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/guided-workflow/campaigns/{campaign_id}/generate-video
  • Auth: HTTP bearer

Path parameters

campaign_idstring required

Request body

modified_promptsobject nullable

Optional map of ad_id to edited structured video prompt

draft_adsobject[] nullable

Optional client-provided draft ads (images/prompts)

user_promptstring nullable

Original user prompt/product description

locationsobject[] nullable

Structured target locations

product_offering_idstring uuid nullable

Product offering ID

countrystring nullable

Country for geo targeting

state_provincestring nullable

State/Province for geo targeting

citystring nullable

City for geo targeting

campaign_goalsstring[] nullable

Optional campaign goals

key_selling_pointsstring nullable

Optional key selling points

bid_strategystring nullable

Optional bidding strategy

budget_rangestring nullable

Optional budget range

budget_allocationobject nullable
budget_constraintsobject nullable
campaign_timingobject nullable
dayparting_enabledboolean nullable
dayparting_configobject nullable
target_platformsstring[] nullable

Requested platforms for this finalize action

lead_forms_by_platform_typeobject nullable

Lead form settings keyed by exact platform type

lead_form_enabledboolean nullable

Legacy Meta/LinkedIn finalize flag; forbidden for Google Search

lead_forms_by_ad_typeobject nullable

Legacy Meta/LinkedIn finalize config; forbidden for Google Search

video_lengthinteger nullable

Video duration is fixed at 10 seconds

video_qualitystring nullable

Requested video quality for this finalize action

provided_media_assetsobject[] nullable

User-provided media assets to use instead of generating primary video/image creative

campaign_opportunity_idstring uuid nullable

Trusted competitor campaign opportunity UUID returned by the draft job

execution_settings_job_idstring nullable

Accepted campaign-ideas job whose deferred fields this finalize must honor

execution_settings_draft_identitystring nullable

Builder draft identity bound to the accepted execution-settings receipt

ugc_style_enabledboolean nullable

Whether to steer the generated video and seed image toward creator-led UGC style

use_fast_modelboolean nullable

Whether to use the Gemini fast video model (lite + 1080p) for video generation

product_descriptionstring nullable

Deprecated: use user_prompt

target_locationsobject[] nullable

Deprecated: use locations

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.