CRcreatify
html_interactive_ads

POST /api/html_interactive_ads/

Changed on

Generate HTML interactive ads for one product, one ad per style.

Create the product first with POST /api/links/ or POST /api/links/link_with_params/; this endpoint takes that link. Async only: POST returns the job immediately; poll the detail route or supply webhook_url.

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Request body

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
linkstring uuid required

The product to advertise: a link from POST /api/links/ (scraped from a URL) or POST /api/links/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_idsstring[] required

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

promotion_infostring nullable

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

custom_promptstring nullable

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

max_size_mbinteger

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

webhook_urlstring uri nullable
status'pending' | 'running' | 'done' | 'failed' required
  • pending - pending
  • running - running
  • done - done
  • failed - failed
failed_reasonstring nullable required
credits_usednumber required

10 credits per ad; failed ads are refunded.

Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
linkstring uuid required

The product to advertise: a link from POST /api/links/ (scraped from a URL) or POST /api/links/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_idsstring[] required

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

promotion_infostring nullable

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

custom_promptstring nullable

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

max_size_mbinteger

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

webhook_urlstring uri nullable
status'pending' | 'running' | 'done' | 'failed' required
  • pending - pending
  • running - running
  • done - done
  • failed - failed
failed_reasonstring nullable required
credits_usednumber required

10 credits per ad; failed ads are refunded.

Changes