Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Studio Campaign
Social Video

createStudioCampaignSocialVideo

Creates a new social video for a studio campaign. The API automatically extracts most data from the campaign, with client-provided values treated as overrides.

post/studio-campaigns/{campaign_id}/share-settings/social-videos

Path parameters

campaign_idinteger required
Example:12345

Campaign ID

Request body

personastring required

The persona for which the video is created

descriptionstring required

Description of the video

main_imagestring required

URL of the main image to use in the video

logo_imagestring

URL of the logo image to use in the video (optional override)

hero_imagestring

URL of the hero image to use in the video (optional override)

Example request

{
  "persona": "donor",
  "description": "Thank you for your donation",
  "main_image": "https://example.com/image.jpg",
  "theme_data": {
    "primary_color": "#FF0000",
    "secondary_color": "#00FF00",
    "font_color": "#000000",
    "font_name": "Sans Serif"
  },
  "logo_image": "https://example.com/logo.jpg",
  "hero_image": "https://example.com/hero.jpg",
  "campaign_content": {
    "campaign_title": "Campaign Title",
    "campaign_paragraphs": "[P1] First paragraph\\n\\n[P2] Second paragraph",
    "campaign_headings": "[H1] First heading\\n\\n[H2] Second heading",
    "campaign_text": "[TITLE] Campaign Title\\n\\n[HEADING 1] First heading\\n\\n[PARAGRAPH 1] First paragraph"
  }
}

Response

Success - The API has accepted the request and started the video generation process. The server will gather all necessary data from the campaign, applying any provided overrides.

statusstring

The initial status of the video generation job

messagestring

A success message

Example response

{
  "status": "pending",
  "message": "Video generation job created successfully"
}