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

# Taimly API

> Проверяйте доставляемость email через API. Узнайте, попадают ли ваши письма во Входящие, Спам или Промоакции.

## Что такое Taimly?

Taimly — сервис проверки доставляемости email-рассылок. Он определяет, в какую папку Gmail помещает ваши письма: **Входящие**, **Спам**, **Промоакции** или другие категории.

Spam Check API позволяет запускать проверки программно и получать результаты по каждому тестовому аккаунту.

## Как это работает

<Steps>
  <Step title="Запустите проверку">
    Отправьте `POST /api/spam-check/start` — получите уникальный `check_id` и список тестовых адресов.
  </Step>

  <Step title="Отправьте тестовое письмо">
    Отправьте **одно письмо** на все адреса из массива `accounts`. Теги в адресах нужны для привязки письма к проверке.
  </Step>

  <Step title="Получите результаты">
    Опрашивайте `GET /api/spam-check/{check_id}` каждые 5–15 секунд. Когда `status` станет `complete` — все результаты готовы.
  </Step>
</Steps>

## Возможности

<CardGroup cols={2}>
  <Card title="Мгновенный старт" icon="bolt">
    Запустите проверку одним запросом — никаких сложных настроек.
  </Card>

  <Card title="Реальные Gmail-аккаунты" icon="envelope">
    Проверка идёт через настоящие Gmail-ящики, а не эмуляцию.
  </Card>

  <Card title="Все категории Gmail" icon="folder-open">
    Primary, Spam, Promotions, Updates, Social, Forums — полная картина.
  </Card>

  <Card title="Простая интеграция" icon="code">
    REST API с Bearer-токеном. Работает с любым языком и платформой.
  </Card>
</CardGroup>

## Быстрый пример

```bash theme={null}
# 1. Запустить проверку
curl -X POST https://taimly.net/api/spam-check/start \
  -H "Authorization: Bearer YOUR_API_KEY"

# 2. Отправьте письмо на адреса из ответа

# 3. Получить результаты
curl https://taimly.net/api/spam-check/a1b2c3d4e5f6 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Следующие шаги

<CardGroup cols={2}>
  <Card title="Быстрый старт" icon="rocket" href="/quickstart">
    Пошаговая инструкция для первой проверки
  </Card>

  <Card title="Аутентификация" icon="key" href="/authentication">
    Как использовать API-ключ
  </Card>
</CardGroup>