Quick Start Guide

Get up and running with the Adbot API in just a few minutes. This guide will walk you through creating your first video.

Prerequisites

  • An Adbot account with API access
  • Your API key (see Authentication)
  • A template ID to use for video generation

Step 1: List Available Templates

First, let's see what templates are available in your account:

curl -X GET https://api.adbot.fi/api/templates \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "success": true,
  "data": [
    {
      "id": "tpl_social_v1",
      "name": "Social Media Video",
      "description": "Vertical video for TikTok and Instagram",
      "formats": ["1080x1920", "1080x1080"],
      "fields": ["headline", "productImage", "ctaText"]
    },
    {
      "id": "tpl_banner_v1",
      "name": "Display Banner",
      "description": "Standard display ad sizes",
      "formats": ["300x250", "728x90", "160x600"],
      "fields": ["headline", "subheadline", "productImage"]
    }
  ]
}

Step 2: Get Template Configuration

Before creating a material, check what data fields the template requires:

curl -X GET https://api.adbot.fi/api/templates/tpl_social_v1/configs \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "success": true,
  "data": {
    "fields": [
      {
        "name": "headline",
        "type": "text",
        "required": true,
        "maxLength": 50
      },
      {
        "name": "productImage",
        "type": "image",
        "required": true,
        "aspectRatio": "1:1"
      },
      {
        "name": "ctaText",
        "type": "text",
        "required": false,
        "default": "Shop Now"
      }
    ]
  }
}

Step 3: Create a Material

Now let's create a video using the template:

curl -X POST https://api.adbot.fi/api/templates/tpl_social_v1/materials \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale Video",
    "data": {
      "headline": "Summer Sale - 50% Off!",
      "productImage": "https://example.com/images/product.png",
      "ctaText": "Shop Now"
    },
    "outputs": ["1080x1920", "1080x1080"]
  }'

Response:

{
  "success": true,
  "data": {
    "id": "mat_abc123",
    "name": "Summer Sale Video",
    "status": "processing",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Step 4: Check Material Status

Video generation takes a few seconds. Poll the material status:

curl -X GET https://api.adbot.fi/api/materials/mat_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (when ready):

{
  "success": true,
  "data": {
    "id": "mat_abc123",
    "name": "Summer Sale Video",
    "status": "ready",
    "videos": [
      {
        "format": "1080x1920",
        "url": "https://cdn.adbot.fi/videos/mat_abc123_1080x1920.mp4",
        "thumbnail": "https://cdn.adbot.fi/thumbs/mat_abc123_1080x1920.jpg"
      },
      {
        "format": "1080x1080",
        "url": "https://cdn.adbot.fi/videos/mat_abc123_1080x1080.mp4",
        "thumbnail": "https://cdn.adbot.fi/thumbs/mat_abc123_1080x1080.jpg"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "completedAt": "2024-01-15T10:30:15Z"
  }
}

Step 5: Download or Publish

Your video is ready! You can:

  • Download the video directly from the URL
  • Publish to advertising platforms (see Materials API)
  • Embed in your website or app

Tip: For batch processing, you can create multiple materials in a single request. See the Python examples for batch generation patterns.

Next Steps