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

# Introduction

> What the Unite API is and how to get started.

The Unite API lets you create and track ad pre-tests straight from your own system.

You send the creative, Unite analyzes it and returns the result: score, pillars, findings and a PDF. You poll the status until the analysis finishes.

## Base URL

```text theme={null}
https://myunite.ai/api/v1
```

All calls use HTTPS and JSON. Fields are camelCase, dates are ISO 8601 UTC and ids are opaque: treat them as text, without interpreting them.

## What you can do

* Read the catalog of channels, formats and brands in your workspace.
* Upload the creative file (image or video).
* Create out-of-home (OOH), digital (Meta and TikTok) and email pre-tests.
* Track the status, read the result and download the PDF.
* Check the workspace pre-test quota.

## How it works

1. A workspace administrator creates an API key in the dashboard.
2. Your system requests an upload address, uploads the file and creates the pre-test.
3. Creation responds right away with `202` and the pre-test is `queued`.
4. Your system polls the pre-test until the status is `completed` (or `failed`).

Pre-tests created through the API show up in the dashboard next to the ones created in the app, and the API also reads the ones created in the app.

## Next steps

> [card] [First pre-test](https://docs.myunite.ai/en/quickstart.md)
>
> From zero to PDF, step by step.

> [card] [Authentication](https://docs.myunite.ai/en/authentication.md)
>
> Keys, permissions, expiry and revocation.

> [card] [Errors](https://docs.myunite.ai/en/errors.md)
>
> Every code and how to fix each one.

> [card] [Results](https://docs.myunite.ai/en/results.md)
>
> How to read score, pillars, findings and the PDF.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.