> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adclear.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> How the Adclear API works, the two services it exposes, and the core concepts you need before integrating.

Adclear runs automated compliance evaluation on promotional content. You upload a file (or submit text), classify it against your organisation's regulatory rules, and receive an evaluation: specific findings, each with a recommendation and cited rules. Results arrive via webhook, or you can poll for them.

## How it works

<Steps>
  <Step title="Upload your file">
    Send the file to the File API. It returns an `uploadId`. Skip this step for inline text or HTML.
  </Step>

  <Step title="Create a promotion">
    Reference the `uploadId` and classify the content by product, channel, and jurisdiction on the Adclear API.
  </Step>

  <Step title="Trigger an evaluation">
    Start the asynchronous compliance review for that version of the promotion.
  </Step>

  <Step title="Receive the result">
    Adclear posts the result to your webhook endpoint when the evaluation finishes, or you can poll for it.
  </Step>
</Steps>

## The two services

Your integration talks to two services that share a single API key.

<CardGroup cols={2}>
  <Card title="File API" icon="cloud-arrow-up">
    `files.adclear.ai`

    Resumable chunked file upload and upload-status tracking.
  </Card>

  <Card title="Adclear API" icon="shield-check">
    `public-api.adclear.ai`

    Promotions, evaluations, reference data, and outbound webhooks.
  </Card>
</CardGroup>

## 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                                                                      |
| ------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| PDF                 | `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 |

Files over the size limit are rejected at upload initiation with `413 Payload Too Large`.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/developer/quickstart">
    Run your first evaluation end to end in under 10 minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/developer/authentication">
    Set up your API key, headers, and environment.
  </Card>
</CardGroup>