Submit a link

curl --request POST \
  --url https://public-api.adclear.ai/v1/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-External-User-ID: <x-external-user-id>' \
  --data '
{
  "url": "https://example.com/landing-page",
  "figmaFrameId": "123:456"
}
'

import requests

url = "https://public-api.adclear.ai/v1/links"

payload = {
    "url": "https://example.com/landing-page",
    "figmaFrameId": "123:456"
}
headers = {
    "X-External-User-ID": "<x-external-user-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-External-User-ID': '<x-external-user-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: 'https://example.com/landing-page', figmaFrameId: '123:456'})
};

fetch('https://public-api.adclear.ai/v1/links', 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://public-api.adclear.ai/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/landing-page',
    'figmaFrameId' => '123:456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-External-User-ID: <x-external-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.adclear.ai/v1/links"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-External-User-ID", "<x-external-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.adclear.ai/v1/links")
  .header("X-External-User-ID", "<x-external-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.adclear.ai/v1/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-External-User-ID"] = '<x-external-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}"

response = http.request(request)
puts response.read_body

{
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "fileFormat": "image",
  "sourceUrl": "<string>",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalFileName": "<string>",
  "previewUrl": "<string>"
}

{
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing",
  "fileFormat": "image",
  "sourceUrl": "<string>",
  "frameId": "<string>",
  "statusUrl": "/v1/links/6f1c1c2e-1234-4bcd-9e0f-abcdef012345",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frameName": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Links

Submit a link

Captures a link as an image upload that can be used in promotions. Generic http(s) URLs are captured synchronously as a full-page screenshot — the call can take up to 2 minutes, so set a generous client timeout; returns 201 with an uploadId. Figma links (figma.com) are imported asynchronously via the Figma API — the file must be shared with “anyone with the link”; returns 202 with an uploadId to poll via GET /v1/links/. A frame must be identified via the node-id query parameter in the URL (“copy link to frame” in Figma) or the figmaFrameId field; discover frame IDs via POST /v1/links/figma/frames. This endpoint is limited to 10 requests per minute per API key.

POST

links

Submit a link

curl --request POST \
  --url https://public-api.adclear.ai/v1/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-External-User-ID: <x-external-user-id>' \
  --data '
{
  "url": "https://example.com/landing-page",
  "figmaFrameId": "123:456"
}
'

import requests

url = "https://public-api.adclear.ai/v1/links"

payload = {
    "url": "https://example.com/landing-page",
    "figmaFrameId": "123:456"
}
headers = {
    "X-External-User-ID": "<x-external-user-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-External-User-ID': '<x-external-user-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: 'https://example.com/landing-page', figmaFrameId: '123:456'})
};

fetch('https://public-api.adclear.ai/v1/links', 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://public-api.adclear.ai/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/landing-page',
    'figmaFrameId' => '123:456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-External-User-ID: <x-external-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.adclear.ai/v1/links"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-External-User-ID", "<x-external-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.adclear.ai/v1/links")
  .header("X-External-User-ID", "<x-external-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.adclear.ai/v1/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-External-User-ID"] = '<x-external-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/landing-page\",\n  \"figmaFrameId\": \"123:456\"\n}"

response = http.request(request)
puts response.read_body

{
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "completed",
  "fileFormat": "image",
  "sourceUrl": "<string>",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalFileName": "<string>",
  "previewUrl": "<string>"
}

{
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing",
  "fileFormat": "image",
  "sourceUrl": "<string>",
  "frameId": "<string>",
  "statusUrl": "/v1/links/6f1c1c2e-1234-4bcd-9e0f-abcdef012345",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frameName": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "<string>",
    "details": [
      {
        "type": "field_error",
        "field": "<string>",
        "message": "<string>"
      }
    ]
  },
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization

string

header

required

Unkey API key passed as Bearer token

Headers

X-External-User-ID

string

required

External user identifier from the calling system

X-External-User-Email

string<email>

External user email from the calling system

Body

application/json

url

string<uri>

required

The link to capture. Generic http(s) URLs are captured as a full-page screenshot. Figma links (figma.com) are imported as an image via the Figma API — the file must be shared with "anyone with the link", and a frame must be identified via a node-id in the URL ("copy link to frame" in Figma) or the figmaFrameId field.

Maximum string length: 2048

Example:

"https://example.com/landing-page"

figmaFrameId

string

Figma frame (node) ID to import, e.g. "123:456". Only valid for figma.com URLs. When omitted, the node-id query parameter from the URL is used. Discover frame IDs via POST /v1/links/figma/frames.

Minimum string length: 1

Example:

"123:456"

Response

URL captured — the upload is ready to use

uploadId

string<uuid>

required

Upload ID of the captured image. Pass in uploadIds when creating a promotion or version (with fileFormat "image").

status

enum<string>

required

Available options:

completed

fileFormat

enum<string>

required

Available options:

image

sourceUrl

string

required

The submitted URL, echoed back

correlationId

string<uuid>

required

Correlation ID for request tracing. Include in support requests.

originalFileName

string

previewUrl

string

Time-limited signed URL to preview the captured image

Get started

Fundamentals

Adclear API

File API

Submit a link

Authorizations

Headers

Body

Response