Adbot API Documentation

Welcome to the Adbot API documentation. Our REST API enables you to programmatically create, manage, and publish videos and banners at scale.

Overview

The Adbot API provides endpoints for managing templates, creating materials (videos and banners), uploading assets, and publishing content to various channels. All API requests must be authenticated using an API key.

Key Features

• Template-based generation - Create materials from pre-designed templates
• Multi-format output - Generate videos for TikTok, YouTube, Instagram, and more
• Asset management - Upload and manage images, with AI background removal
• Direct publishing - Publish to Meta, digital signage, and programmatic platforms
• Batch processing - Generate hundreds of variants in a single request

Quick Start

Here's a quick example to get you started. This creates a video from a template:

curl -X POST https://api.adbot.fi/api/templates/TEMPLATE_ID/materials \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "headline": "Summer Sale - 50% Off",
      "productImage": "https://example.com/product.png"
    }
  }'

API Endpoints

The API is organized around the following resources:

Response Format

All API responses are returned in JSON format. Successful responses include the requested data:

{
  "success": true,
  "data": {
    "id": "mat_123abc",
    "name": "Summer Campaign Video",
    "status": "ready",
    "videoUrl": "https://cdn.adbot.fi/videos/mat_123abc.mp4"
  }
}

Error Handling

Errors are returned with appropriate HTTP status codes and a JSON body:

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired"
  }
}

Common HTTP Status Codes

Need Help?

If you have questions or need assistance, contact our support team at ohjelmistotuki@adbot.fi.