Skip to content

API Integration

Quick Start

  • Get your API key from your Pablo dashboard
  • Add the key to the header of your requests: X-API-Key: YOUR_API_KEY_HERE (an api_key query parameter is also accepted)
  • Create an ad using the POST /api/v1/ads/create endpoint
  • Monitor progress via the /api/v1/builds endpoints

Interactive API reference

The live, always-current API reference (Swagger UI) is served by the app itself:

app.pablo.social/docs/api — interactive Swagger UI (try requests directly) app.pablo.social/docs/api/redoc — the same reference in ReDoc form

Note: the generated schema view shows the required fields; the request examples on POST /api/v1/ads/create are the best reference for the full field surface (optional assets, multi-text options, partnership fields, plural carousel arrays).

Monitoring builds

Endpoint Purpose
GET /api/v1/builds/ List builds. Filters: status (building / qa / error), account_id, source_type, period, plus cursor / limit / offset
GET /api/v1/builds/summary Aggregate counts by status
GET /api/v1/builds/{build_id} One build in full

The period filter takes one string — a named window (last_30d, mtd, last_quarter), an ISO week (2026-W24), a month (2026-06), or an explicit range (2026-07-01..2026-07-31).

Renamed parameters refuse loudly: earlier spellings — relative, start, end, date_field, ad_account_id, ad_set_id, breakdowns, filtering — now return a 400 naming the replacement, rather than being silently ignored. If an older integration starts getting 400s, update to period / account_id.

Field Reference

For complete field documentation including validation rules, allowed values, and requirements: