# Unite ## Guias ### Primeiros passos - [Introdução](https://docs.myunite.ai/index.md): O que é a Unite API e como começar. - [Primeiro pré-teste](https://docs.myunite.ai/quickstart.md): Do zero ao PDF: crie a chave, envie um criativo e leia o resultado. - [Autenticação](https://docs.myunite.ai/authentication.md): Chaves de API, permissões, validade e revogação. ### Conceitos - [Envio de arquivos](https://docs.myunite.ai/uploads.md): Como enviar imagens e vídeos antes de criar um pré-teste. - [Idempotência](https://docs.myunite.ai/idempotency.md): Como repetir uma criação com segurança usando Idempotency-Key. - [Paginação e filtros](https://docs.myunite.ai/pagination.md): Como percorrer a lista de pré-testes. - [Limites de uso](https://docs.myunite.ai/rate-limits.md): Quantas chamadas cada chave pode fazer e como reagir ao limite. - [Erros](https://docs.myunite.ai/errors.md): Formato dos erros da API, todos os códigos e como resolver cada um. ### Pré-testes - [Pré-teste OOH](https://docs.myunite.ai/pretests/ooh.md): Crie um pré-teste de mídia exterior. - [Pré-teste digital](https://docs.myunite.ai/pretests/digital.md): Crie um pré-teste de anúncio para Meta ou TikTok. - [Pré-teste de e-mail](https://docs.myunite.ai/pretests/email.md): Crie um pré-teste de e-mail marketing. - [Resultados](https://docs.myunite.ai/results.md): Como ler status, nota, pilares, achados e PDF de um pré-teste. - [Webhooks](https://docs.myunite.ai/webhooks.md): Receba um aviso no seu servidor quando um pré-teste termina, falha ou tem o PDF pronto, e confira a assinatura de cada envio. ### Novidades - [Changelog](https://docs.myunite.ai/changelog.md): Mudanças na Unite API. ## Referência da API ### Catalog - [Get the catalog of channels, formats and brands](https://docs.myunite.ai/api-reference/catalog/get-the-catalog-of-channels-formats-and-brands.md): Returns what you can send when you create a pre-test: the channels, the OOH formats, the digital platforms and placements, the email types and stages, the checks each channel runs, and the brands of your workspace with the guideline data each one has. Names and labels come in the language of the loc… ### Uploads - [Create an upload target for a creative file](https://docs.myunite.ai/api-reference/uploads/create-an-upload-target-for-a-creative-file.md): Creates a pre-signed URL to upload a creative file. Send the file with a PUT to uploadUrl, using the method and every header returned in headers, with exactly those values (Cache-Control is part of them). The URL is valid for 15 minutes. Then pass uploadId when you create the pre-test. Accepted type… ### Pretests - [List pre-tests](https://docs.myunite.ai/api-reference/pretests/list-pre-tests.md): Lists the pre-tests of your workspace, newest first, including the ones created in the app. Results are paginated with a cursor. - [Create a pre-test](https://docs.myunite.ai/api-reference/pretests/create-a-pre-test.md): Creates a pre-test from a file you uploaded with POST /uploads. The response is 202: the analysis runs in the background. Poll GET /pretests/{id} until status is completed or failed. The Location header points to the new pre-test. The Idempotency-Key header is required: repeating a request with the… - [Get a pre-test](https://docs.myunite.ai/api-reference/pretests/get-a-pre-test.md): Returns one pre-test. result is present when status is completed, error when it is failed. The state you read here is the source of truth. - [Get the PDF report of a pre-test](https://docs.myunite.ai/api-reference/pretests/get-the-pdf-report-of-a-pre-test.md): Returns the PDF report of a completed pre-test. It starts generating the report for any completed pre-test that does not have one yet: you get 202 with status generating and a Retry-After header, so call again after that many seconds. When it is ready you get 200 with the download url. On the pre-te… ### Quota - [Get the pre-test quota](https://docs.myunite.ai/api-reference/quota/get-the-pre-test-quota.md): Returns how many pre-tests your workspace can still run in the current period. ### Webhooks - [List webhook endpoints](https://docs.myunite.ai/api-reference/webhooks/list-webhook-endpoints.md): Lists the webhook endpoints of your workspace, including disabled ones. The signing secret is never returned here: it is shown only when you create the endpoint. - [Create a webhook endpoint](https://docs.myunite.ai/api-reference/webhooks/create-a-webhook-endpoint.md): Creates a webhook endpoint. We send a signed HTTPS POST to url for each event type you subscribe to, following the Standard Webhooks format (webhook-id, webhook-timestamp and webhook-signature headers). The response includes the signing secret, shown only once: store it now. A workspace can have at… - [Delete a webhook endpoint](https://docs.myunite.ai/api-reference/webhooks/delete-a-webhook-endpoint.md): Deletes a webhook endpoint and its delivery history. Events that were still waiting to be delivered to it are dropped. - [Send a test event to a webhook endpoint](https://docs.myunite.ai/api-reference/webhooks/send-a-test-event-to-a-webhook-endpoint.md): Queues a test event of type ping, signed like any other event, to check that your server receives and verifies it. The response is 202: read the result in GET /webhook-endpoints/{id}/deliveries. A disabled endpoint cannot be tested. - [List recent deliveries of a webhook endpoint](https://docs.myunite.ai/api-reference/webhooks/list-recent-deliveries-of-a-webhook-endpoint.md): Returns the last 50 deliveries to an endpoint, newest first, with their status, number of attempts and the HTTP status of the last attempt. Failed attempts are retried for several hours before a delivery is marked failed. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English (26 pages)](https://docs.myunite.ai/_llms/en.txt): Guides, API reference. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.