How it works
Upload your file
Send the file to the File API. It returns an
uploadId. Skip this step for inline text or HTML.Create a promotion
Reference the
uploadId and classify the content by product, channel, and jurisdiction on the Adclear API.The two services
Your integration talks to two services that share a single API key.File API
files.adclear.aiResumable chunked file upload and upload-status tracking.Adclear API
public-api.adclear.aiPromotions, evaluations, reference data, and outbound webhooks.Key concepts
| Concept | Description |
|---|---|
| Promotion | A piece of promotional content submitted for compliance review |
| Version | An immutable snapshot of the uploaded files within a promotion. Version 1 is created with the promotion; later versions are revisions |
| Evaluation | An asynchronous compliance review of one version. Produces a set of issues, each with cited rules |
| Webhook | An outbound HTTP POST from Adclear to your endpoint when an event occurs, such as an evaluation completing |
| Metadata | An arbitrary string key-value map you attach at promotion creation. Adclear stores it and echoes it back in every webhook, so you can correlate events to your own records |
Supported file formats
| Format | MIME type | Max size |
|---|---|---|
application/pdf | 30 MB | |
| PNG | image/png | 30 MB |
| JPEG | image/jpeg | 30 MB |
| WebP | image/webp | 30 MB |
| MP4 | video/mp4 | 2 GB |
| MOV | video/quicktime | 2 GB |
| MP3 | audio/mpeg | 2 GB |
| WAV | audio/wav | 2 GB |
| DOCX | application/vnd.openxmlformats-officedocument.wordprocessingml.document | 10 MB |
| XLSX | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | 10 MB |
| Inline text or HTML | N/A | Submitted via the content field as fileFormat: "text", no upload required |
413 Payload Too Large.
Quickstart
Run your first evaluation end to end in under 10 minutes.
Authentication
Set up your API key, headers, and environment.