API Reference

Interactive documentation with live request testing

Quick Start

The typical integration flow follows these steps:

  1. POST /api/brand — Create a brand with your orgId and website URL. Identity extraction and research run automatically.
  2. POST /api/campaigns — Create a campaign with the brand's ID, a type, and an optional brief.
  3. POST /api/campaigns/{id}/generate — Trigger asset generation. Returns immediately.
  4. GET /api/campaigns/{id} — Poll until pollStatus.status is done or error.

Polling Pattern

All generate endpoints are non-blocking. After triggering generation, poll GET /api/campaigns/{id} every few seconds. The response includes:

{
  "pollStatus": {
    "status": "processing" | "done" | "error",
    "url": "/uploads/...",     // when done
    "reason": "error message"  // when error
  }
}

System

Health check and system status. No authentication required.

Brand Profile

Create, update, and manage brand profiles. Supports admin provisioning: send X-Admin-Key header to auto-create an organization and receive an API key.

Brand Uploads

Upload brand media files — logos, screenshots, recordings, and ambassador images. All uploads are multipart/form-data.

Auto-Capture

Automatically capture screenshots and record feature demos from web and mobile apps using headless browsers and emulators.

Campaigns

List, view, delete, and manage campaigns. To create + generate a campaign, use the per-type endpoints in the Generation section below.

Generation

Create and generate campaigns in a single call. Each campaign type has its own endpoint with type-specific parameters. All endpoints are non-blocking — they return a jobId immediately. Poll GET /api/campaigns/{jobId} for status, or provide webhookUrl for push notifications.

New Campaign Types

Additional campaign types for SaaS marketing. Social proof, multi-platform ads, audiograms, event promos, case studies, and content series.

Demos & Showcases

Generate product demo videos and AI-designed showcase videos. Use the brandId-first endpoints (recommended) which auto-create a campaign, or the legacy campaign-ID endpoints for existing campaigns.

Bundles

Group multiple campaigns into a bundle for batch planning and generation.

Social & Scheduling

Schedule campaigns and manage LinkedIn publishing.

Sync & Integration

Cross-service resource mapping, asset import, and webhook support for VenturOS integration. External mappings link internal campaign/bundle/asset IDs to partner system IDs.

Admin & Org Management

Organization lifecycle, API key management, dashboard statistics, and internal tools. Org management endpoints require X-Admin-Key header.

Deprecated

Legacy endpoints kept for backward compatibility. These will be removed in a future version. Migrate to the per-type Generation endpoints (POST /api/campaigns/generate/{type}) which create and generate in a single call.