# Adclear Manual

- [Welcome to Adclear](https://docs.adclear.ai/introduction.md): AI-assisted compliance review for promotional content, built around your policies, your tone of voice, and your team.
- [Getting started](https://docs.adclear.ai/overview.md): Set up your Adclear account, sign in, and configure your notifications.
- [How roles work](https://docs.adclear.ai/how-roles-work.md): Understand the different roles in Adclear and what each one can do.
- [Upload types](https://docs.adclear.ai/upload-types.md): The four ways to upload promotions in Adclear, when to use each, and how each one behaves under review.
- [Single](https://docs.adclear.ai/upload-types/single.md): One asset submitted as one promotion, with one approval decision.
- [Carousel](https://docs.adclear.ai/upload-types/carousel.md): One or more frames grouped into a single promotion, reviewed and approved as one unit.
- [Variations](https://docs.adclear.ai/upload-types/variations.md): Multiple linked promotions with the same core message, each reviewed independently.
- [Batch](https://docs.adclear.ai/upload-types/batch.md): Multiple unrelated standalone promotions uploaded in one go, each reviewed independently.
- [Promotion statuses](https://docs.adclear.ai/promotion-statuses.md): A reference guide to every status a promotion can have in Adclear, and what each one means.
- [Helping Adclear learn](https://docs.adclear.ai/how-you-help-adclear-learn.md): How your responses to comments train Adclear's agents, and how to raise issues with the right team.
- [Feature catalog](https://docs.adclear.ai/feature-catalog.md): Every Adclear feature in one place, grouped into Included and Add-on.
- [System status alerts](https://docs.adclear.ai/system-status-alerts.md): What the banner at the top of Adclear means when there's an active incident or scheduled maintenance.
- [Overview](https://docs.adclear.ai/marketing/overview.md): Everything you need to upload, manage, and track your promotional content in Adclear.
- [Promotion dashboard](https://docs.adclear.ai/marketing/promotion-dashboard.md): Your home screen for tracking every promotion you've uploaded, with filtering, saved views, and exporting.
- [Renaming promotions](https://docs.adclear.ai/marketing/renaming-promotions.md): How to rename a promotion from the promotion viewer header.
- [Uploading guidance](https://docs.adclear.ai/marketing/uploading-guidance.md): Pick the right upload type and prepare your files so Adclear can assess them properly the first time.
- [Choosing the right upload type](https://docs.adclear.ai/marketing/choosing-file-type.md): How to decide between Single, Carousel, Variations, and Batch for your specific workflow.
- [Upload quality guide](https://docs.adclear.ai/marketing/upload-quality-guide.md): Make sure Adclear can clearly assess what you upload, and avoid the most common causes of inaccurate flags.
- [Importing from Frame.io](https://docs.adclear.ai/marketing/importing-from-frameio.md): Connect your Frame.io account and import videos straight into a promotion by pasting a Frame.io link.
- [Importing from Google Drive](https://docs.adclear.ai/marketing/importing-from-google-drive.md): Import a Google Drive file or Google Doc straight into a promotion by pasting a link, and pull later edits back in as new versions. Connecting your Google account for private and shared files is coming soon.
- [Supporting the review cycle](https://docs.adclear.ai/marketing/supporting-review-cycle.md): Submit your promotion, track the decision, manage versions, and collaborate on comments.
- [Submitting for review](https://docs.adclear.ai/marketing/submitting-for-review.md): Create a promotion, fill in the required fields, and submit it for review.
- [After review](https://docs.adclear.ai/marketing/after-review.md): What each review decision means and what your next step is.
- [Versions](https://docs.adclear.ai/marketing/versions.md): Upload new versions of a promotion, and understand version history.
- [Previewing promotions](https://docs.adclear.ai/marketing/previewing-promotions.md): Zoom, pan, fit, search, and navigate images, PDFs, and videos in the promotion preview, and place comments from the control bar.
- [Comments and collaboration](https://docs.adclear.ai/marketing/comments-collaboration.md): Leave inline comments on text, images, video, and PDFs, and work with collaborators on a promotion.
- [Claims](https://docs.adclear.ai/marketing/claims.md): Create, link, and version substantiated marketing statements that can be used across promotions.
- [Escalations](https://docs.adclear.ai/marketing/escalations.md): Escalate a Rejected or Changes Needed decision for risk acceptance review.
- [FAQs](https://docs.adclear.ai/marketing/faqs.md): Answers to the questions uploaders ask most often.
- [Overview](https://docs.adclear.ai/compliance/overview.md): Everything you need to review, approve, and manage promotional content in Adclear.
- [Tasks & dashboard](https://docs.adclear.ai/compliance/tasks-and-dashboard.md): Your working queue, the promotion dashboard, filtering, saved views, and exporting.
- [Making review decisions](https://docs.adclear.ai/compliance/review-decisions.md): How to review a promotion and apply Approve, Conditionally Approve, Reject, or Request Changes.
- [Commenting on promotions](https://docs.adclear.ai/compliance/commenting.md): How to annotate text, images, videos, and PDFs during review.
- [Rejection & changes-requested reasons](https://docs.adclear.ai/compliance/rejection-reasons.md): Configure reusable reasons for promotions and claims, and apply them when rejecting or requesting changes.
- [Escalations](https://docs.adclear.ai/compliance/escalations.md): Escalating to legal and handling risk acceptance flows.
- [Reviewing claims](https://docs.adclear.ai/compliance/claims.md): How to review, version, and archive claims in Adclear.
- [Policies & disclaimers](https://docs.adclear.ai/compliance/policies.md): Managing compliance policies and reusable disclaimer text in Adclear.
- [FAQs](https://docs.adclear.ai/compliance/faqs.md): Common questions from reviewers using Adclear.
- [Rule visibility](https://docs.adclear.ai/rule-visibility.md): How Adclear turns your policies into operational rules, and where to see them inside the platform.
- [Multi-level approval](https://docs.adclear.ai/multi-level-approval.md): Route promotions through multiple reviewers in parallel or sequential flows using reviewer presets.
- [External reviewer access](https://docs.adclear.ai/external-reviewer.md): Invite an external reviewer, assign promotions, and complete reviews from the restricted external queue.
- [Self-approval](https://docs.adclear.ai/self-approval.md): How eligible uploaders approve their own promotions under workspace controls.
- [External submission form](https://docs.adclear.ai/external-submission-form.md): How agencies, affiliates, and influencers submit promotional content to Adclear for review.
- [My Submissions](https://docs.adclear.ai/my-submissions.md): How external partners track their submitted promotions, check review status, and create new submissions.
- [External affiliate access](https://docs.adclear.ai/external-influencer-access.md): How to link affiliates and agencies as External Uploaders so they can view their own monitored channels and compliance status.
- [Chrome extension](https://docs.adclear.ai/chrome-extension.md): Review ad copy from any web page in a side panel, then save drafts and feedback back to Adclear.
- [Affiliate monitoring](https://docs.adclear.ai/monitoring/overview.md): Overview of post-publication affiliate monitoring in Adclear: the Monitoring inbox, Affiliates hub, and three channel types.
- [Website monitoring](https://docs.adclear.ai/monitoring/website-monitoring.md): Set up website URL monitors, review recheck versions, and manage post-publication compliance for affiliate sites.
- [Discord monitoring](https://docs.adclear.ai/monitoring/discord-monitoring.md): Connect Discord servers, configure Approved Copy, and review flagged affiliate messages in Adclear.
- [Social media monitoring](https://docs.adclear.ai/monitoring/social-media-monitoring.md): Configure social media handles, set relevancy rules, and review flagged affiliate posts in Adclear.
- [Metrics](https://docs.adclear.ai/metrics.md): Plain-English definitions of every metric on the Analytics page, what each one measures, and what it includes and excludes.
- [Settings](https://docs.adclear.ai/settings.md): Configure your account and workspace in Adclear, from personal preferences to compliance workflows and integrations.
- [Configure self-approval rules](https://docs.adclear.ai/settings/self-approval-rules.md): Create workspace rules that control who can self-approve which promotions.
- [Set up SSO with Okta](https://docs.adclear.ai/sso/okta.md): Connect Okta as your organisation's identity provider so your team signs in to Adclear with their existing Okta accounts.
- [Set up SSO with Microsoft Entra ID](https://docs.adclear.ai/sso/azure.md): Connect Microsoft Entra ID as your organisation's identity provider so your team signs in to Adclear with their existing Microsoft accounts.
- [Introduction](https://docs.adclear.ai/developer/introduction.md): How the Adclear API works, the two services it exposes, and the core concepts you need before integrating.
- [Quickstart](https://docs.adclear.ai/developer/quickstart.md): Upload a file, create a promotion, and get your first compliance evaluation back in under 10 minutes.
- [Authentication](https://docs.adclear.ai/developer/authentication.md): The headers every request needs, how API keys are scoped, and how to choose between staging and production.
- [Reference data](https://docs.adclear.ai/developer/reference-data.md): Fetch the product, channel, jurisdiction, and target-market IDs your organisation uses to classify a promotion.
- [File upload](https://docs.adclear.ai/developer/file-upload.md): Upload files to the File API with the resumable chunked protocol, then reference them when creating a promotion.
- [Link submission](https://docs.adclear.ai/developer/links.md): Submit a URL, a Figma frame, or a Google Drive file instead of uploading a file. Adclear captures it and gives you an upload ID to reference when creating a promotion.
- [Creating promotions](https://docs.adclear.ai/developer/promotions.md): Create a promotion from uploaded files or inline text, and create new versions when content is revised.
- [Evaluation](https://docs.adclear.ai/developer/evaluation.md): Trigger an asynchronous compliance evaluation of a promotion version and read the results.
- [Comments](https://docs.adclear.ai/developer/comments.md): Read and import AI and human review comments on a promotion version.
- [Webhooks](https://docs.adclear.ai/developer/webhooks.md): Receive evaluation and review lifecycle events automatically, verify signatures, and handle payloads.
- [Errors & rate limits](https://docs.adclear.ai/developer/errors.md): The shared error envelope, every error code, rate limits, and fixes for the issues integrators hit most.
- [Create promotion](https://docs.adclear.ai/api-reference/api/promotions/create-promotion.md): Creates a new promotion and its first version. For file-based formats (pdf, image, video, etc.), upload files first via the File API and provide uploadIds. For text format, provide inline content instead of uploadIds. Returns 409 if any referenced upload has not finished uploading to storage.
- [Create version](https://docs.adclear.ai/api-reference/api/promotions/create-version.md): Creates a new version. Inherits promotionName, channel, product, and jurisdiction from the existing promotion. For file-based formats, provide uploadIds. For text format, provide inline content instead. Returns 409 if any referenced upload has not finished uploading to storage.
- [Submit version for review](https://docs.adclear.ai/api-reference/api/promotions/submit-version-for-review.md): Submits a saved single-review version for compliance review. Optionally assigns a reviewer by email and overrides the version deadline. When the version is already pending or approved, returns its current status and ignores any reviewer or deadline fields (safe retry behaviour).
- [Submit a link](https://docs.adclear.ai/api-reference/api/links/submit-a-link.md): Captures a link as an 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 Figm…
- [List Figma frames](https://docs.adclear.ai/api-reference/api/links/list-figma-frames.md): Lists the pages and frames of a Figma file so a frame can be selected for import via POST /v1/links. The file must be shared with "anyone with the link". This endpoint is limited to 10 requests per minute per API key.
- [Get link import status](https://docs.adclear.ai/api-reference/api/links/get-link-import-status.md): Returns the status of a link submitted via POST /v1/links. Poll the statusUrl from that response rather than building this URL yourself — it carries the source query parameter that tells the poll which provider to check. When status is "completed", pass finalUploadId in uploadIds when creating a pro…
- [Trigger evaluation](https://docs.adclear.ai/api-reference/api/evaluation/trigger-evaluation.md)
- [Get evaluation](https://docs.adclear.ai/api-reference/api/evaluation/get-evaluation.md)
- [Get comments](https://docs.adclear.ai/api-reference/api/evaluation/get-comments.md): Returns comments on a version — AI-generated and human review — grouped into paginated threads. Each thread has one top-level comment plus its replies in chronological order.
- [Import comments](https://docs.adclear.ai/api-reference/api/evaluation/import-comments.md): Import external review comments, replies, and action responses onto the latest version. Returns per-item results in request order. Send externalCommentId on every item for safe sequential retries; concurrent duplicate requests may race. Location anchors must already be collapsed: send the centre poi…
- [Get decision](https://docs.adclear.ai/api-reference/api/review/get-decision.md): Returns the current review decision for a promotion version. Once a decision has been made on the version, the response also includes who made the decision, when, and the reason if one was recorded.
- [Record decision](https://docs.adclear.ai/api-reference/api/review/record-decision.md): Records the authoritative human review decision on a version: approve, reject, or request changes. The decision is permission-gated on the reviewer's access to the promotion's country.
- [Assign or change reviewer](https://docs.adclear.ai/api-reference/api/review/assign-or-change-reviewer.md): Assigns or changes the reviewer on a version. The reviewer must be an Adclear user with review access to the promotion's country.
- [Unassign reviewer](https://docs.adclear.ai/api-reference/api/review/unassign-reviewer.md): Removes the currently assigned reviewer from a version.
- [List products](https://docs.adclear.ai/api-reference/api/list-products.md)
- [List channels](https://docs.adclear.ai/api-reference/api/list-channels.md)
- [List jurisdictions](https://docs.adclear.ai/api-reference/api/list-jurisdictions.md)
- [List target markets](https://docs.adclear.ai/api-reference/api/list-target-markets.md)
- [Evaluation completed](https://docs.adclear.ai/api-reference/api/webhooks/evaluation-completed.md): Sent when a compliance evaluation finishes (success or failure). Comment-backed issues normally include a commentId that can be sent as parentCommentId when posting a reply; replayed deliveries may omit it. If the reply briefly returns PARENT_NOT_FOUND, retry because comment indexing is asynchronous…
- [Comment created](https://docs.adclear.ai/api-reference/api/webhooks/comment-created.md): Sent when a comment is added to a promotion version.
- [Review submitted](https://docs.adclear.ai/api-reference/api/webhooks/review-submitted.md): Sent when a promotion version is submitted for review.
- [Review approved](https://docs.adclear.ai/api-reference/api/webhooks/review-approved.md): Sent when a promotion version receives a terminal approval decision.
- [Review changes requested](https://docs.adclear.ai/api-reference/api/webhooks/review-changes-requested.md): Sent when a reviewer requests changes on a promotion version.
- [Review rejected](https://docs.adclear.ai/api-reference/api/webhooks/review-rejected.md): Sent when a promotion version is rejected.
- [Initiate upload](https://docs.adclear.ai/api-reference/file-api/upload/initiate-upload.md): Creates a GCS resumable upload session behind our domain. The caller PUTs file chunks to the returned uploadUrl with Content-Range headers.
- [Get upload status](https://docs.adclear.ai/api-reference/file-api/upload/get-upload-status.md): Returns the current status and metadata of an upload.
- [Upload chunk](https://docs.adclear.ai/api-reference/file-api/upload/upload-chunk.md): Streams a chunk of file data to the underlying storage. Include a Content-Range header (e.g. `bytes 0-1048575/5242880`) and send the raw bytes as the request body. When the total is known and this is the final chunk, the upload completes and the status becomes `completed`.
- [Delete upload](https://docs.adclear.ai/api-reference/file-api/upload/delete-upload.md): Deletes the GCS file (primary + display variant if present), cleans up any lingering upload session, and hard-deletes the upload record from the database. Returns 404 if the upload does not exist or does not belong to the authenticated user.
- [What's new](https://docs.adclear.ai/changelog.md): New features and improvements to Adclear

## OpenAPI Specs

- [openapi](/openapi.json)
- [file-api](/openapi/file-api.json)
- [integration-api](/openapi/integration-api.json)