Developer API

Campaign automation for ecommerce growth teams.

Use the Nuvid API from your own backend to create campaign workflows, generate banners and images, queue product-led video jobs, read status, and list connected asset metadata. Provider OAuth tokens never leave Nuvid.

Create API key Talk to Nuvid

Hashed keys

Full API keys are shown once and stored as server-side hashes.

Real outputs

Campaign, creative and video requests create tracked D1 records.

Credit-aware

Video jobs use the same credit balance as the dashboard.

No token leaks

Google, Meta, Shopify and WooCommerce tokens stay server-side.

Base URL

https://app.nuvid.ai/api/public/v1

Authentication

Create API keys inside Dashboard → API. Include the key as a Bearer token from your backend. Do not put API keys in browser JavaScript.

Authorization: Bearer nv_live_xxxxxxxxxxxxxxxxxxxx

Create a campaign workflow

curl https://app.nuvid.ai/api/public/v1/campaigns \
  -H "Authorization: Bearer nv_live_..." \
  -H "Content-Type: application/json" \
  --data '{
    "product_url": "https://store.com/products/jacket",
    "goal": "create a launch campaign",
    "formats": ["brief", "banners", "images", "video_ads"],
    "brand": { "name": "Store", "primary_color": "#10B981" },
    "copy": { "headline": "Winter-ready without the bulk", "cta": "Shop now" },
    "output_language": "auto"
  }'

Returns 202 Accepted, a campaign job ID, optional creative asset URLs, optional video job ID, and a status URL. Video jobs consume credits.

Create banners and social images

curl https://app.nuvid.ai/api/public/v1/creatives \
  -H "Authorization: Bearer nv_live_..." \
  -H "Content-Type: application/json" \
  --data '{
    "product_url": "https://store.com/products/jacket",
    "asset_types": ["banner", "image"],
    "formats": ["1200x628", "728x90", "1:1", "9:16"],
    "brand": { "name": "Store", "primary_color": "#10B981" },
    "copy": {
      "headline": "Winter-ready without the bulk",
      "subhead": "A focused product-led campaign asset.",
      "cta": "Shop now"
    }
  }'

Returns CDN asset URLs and saves each output to Nuvid Library and Studio Lite where supported. These are real generated creative assets, not mock records.

POST/campaigns

Create campaign workflow

{
  "product_url": "https://store.com/products/jacket",
  "goal": "create a launch campaign",
  "formats": ["brief", "banners", "images", "video_ads"],
  "brand": { "name": "Store", "primary_color": "#10B981" },
  "copy": { "headline": "Winter-ready without the bulk", "cta": "Shop now" },
  "output_language": "auto"
}

POST/creatives

Create banners and images

{
  "product_url": "https://store.com/products/jacket",
  "asset_types": ["banner", "image"],
  "formats": ["1200x628", "728x90", "1:1", "9:16"],
  "brand": { "name": "Store", "primary_color": "#10B981" },
  "copy": {
    "headline": "Winter-ready without the bulk",
    "subhead": "A focused product-led campaign asset.",
    "cta": "Shop now"
  }
}

GET/campaigns/{campaign_job_id}

Get campaign and render status

{
  "id": "uuid",
  "status": "processing",
  "video_job": {
    "id": "uuid",
    "status": "pending"
  }
}

POST/videos

Queue video creative

{
  "product_url": "https://store.com/products/jacket",
  "headline": "Winter-ready without the bulk",
  "cta": "Shop the jacket",
  "format": "9:16",
  "language": "en"
}

GET/assets

List connected assets

{
  "data": [
    {
      "provider": "google",
      "asset_type": "search_console_property",
      "asset_name": "https://store.com/"
    }
  ]
}

Errors

{
  "error": {
    "code": "insufficient_credits",
    "message": "Not enough credits. Required: 45.",
    "balance": 12,
    "required": 45
  }
}

Nuvid returns standard HTTP status codes: 400 for invalid input, 401 for invalid keys, 403 for missing scopes, 402 for insufficient credits, and 5xx for platform errors.

Webhooks

Webhook subscriptions are planned for campaign events such as campaign.created, creative.ready, video.rendered and credits.low. Until then, poll the campaign status endpoint from your server.

Webhooks are documented here before public rollout