Skip to main content
GET
cURL

Authorizations

X-API-ID
string
header
required

API ID, from your settings page.

X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

id
string<uuid>
required

A UUID string identifying this HTML Interactive Ad.

Response

200 - application/json
id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only

The product to advertise: a link from POST /api/links/ (scraped from a URL) or POST /api/link_with_params/ (your own title and images). Fix its title, images and logo with PUT /api/links/{id}/ first, because the ads are built from exactly what the link holds.

style_ids
string[]
required

The styles to use, one ad per style, from GET /api/html_interactive_ads/styles/.

Required array length: 1 - 20 elements
status
enum<string>
required
  • pending - pending
  • running - running
  • done - done
  • failed - failed
Available options:
pending,
running,
done,
failed
failed_reason
string | null
required
read-only
ads
object[]
required
read-only
credits_used
number
required
read-only

10 credits per ad; failed ads are refunded.

promotion_info
string | null

Offer to feature in the ads, e.g. '20% off this week'.

custom_prompt
string | null

Extra direction for the ads, e.g. tone or what to emphasize.

max_size_mb
integer
default:5

Largest file size per ad, in MB. Images are compressed to fit; an ad that still does not fit fails and is refunded.

Required range: 5 <= x <= 15
webhook_url
string<uri> | null
Maximum string length: 200