curl --request GET \
--url https://api.creatify.ai/api/html_interactive_ads/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/html_interactive_ads/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/html_interactive_ads/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/html_interactive_ads/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/html_interactive_ads/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/html_interactive_ads/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/html_interactive_ads/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"style_ids": [
"<string>"
],
"status": "pending",
"failed_reason": "<string>",
"ads": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"style_id": "<string>",
"status": "pending",
"html_url": "<string>",
"size_bytes": 123,
"failed_reason": "<string>"
}
],
"credits_used": 123,
"promotion_info": "<string>",
"custom_prompt": "<string>",
"max_size_mb": 5,
"webhook_url": "<string>"
}
]List HTML interactive ad requests
List the HTML interactive ad requests in your workspace.
curl --request GET \
--url https://api.creatify.ai/api/html_interactive_ads/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/html_interactive_ads/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/html_interactive_ads/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/html_interactive_ads/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/html_interactive_ads/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/html_interactive_ads/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/html_interactive_ads/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"style_ids": [
"<string>"
],
"status": "pending",
"failed_reason": "<string>",
"ads": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"style_id": "<string>",
"status": "pending",
"html_url": "<string>",
"size_bytes": 123,
"failed_reason": "<string>"
}
],
"credits_used": 123,
"promotion_info": "<string>",
"custom_prompt": "<string>",
"max_size_mb": 5,
"webhook_url": "<string>"
}
]Authorizations
API ID, from your settings page.
API Key, from your settings page.
Query Parameters
Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.
1Response
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.
The styles to use, one ad per style, from GET /api/html_interactive_ads/styles/.
1 - 20 elementspending- pendingrunning- runningdone- donefailed- failed
pending, running, done, failed Show child attributes
Show child attributes
10 credits per ad; failed ads are refunded.
Offer to feature in the ads, e.g. '20% off this week'.
Extra direction for the ads, e.g. tone or what to emphasize.
Largest file size per ad, in MB. Images are compressed to fit; an ad that still does not fit fails and is refunded.
5 <= x <= 15200
