> ## 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.

# Начать проверку

> Создаёт новую проверку доставляемости. Возвращает уникальный `check_id` и список тестовых адресов, на которые нужно отправить письмо.

Каждый адрес содержит тег `+tc_{check_id}` — он используется для привязки вашего письма к проверке. Отправьте **одно письмо** на все адреса из массива `accounts`.

По умолчанию проверка идёт по всем доступным почтам. Чтобы проверить письмо только на некоторых, передайте их в поле `accounts` тела запроса — в ответе и в результатах будут только они.



## OpenAPI

````yaml /openapi.json post /api/spam-check/start
openapi: 3.1.0
info:
  title: Taimly API
  version: 1.3.0
  description: >-
    API Taimly: проверка доставляемости email (Spam Check) и временные почты для
    приёма писем.
servers:
  - url: https://taimly.net
    description: Production
security:
  - BearerAuth: []
paths:
  /api/spam-check/start:
    post:
      tags:
        - Spam Check
      summary: Начать проверку
      description: >-
        Создаёт новую проверку доставляемости. Возвращает уникальный `check_id`
        и список тестовых адресов, на которые нужно отправить письмо.


        Каждый адрес содержит тег `+tc_{check_id}` — он используется для
        привязки вашего письма к проверке. Отправьте **одно письмо** на все
        адреса из массива `accounts`.


        По умолчанию проверка идёт по всем доступным почтам. Чтобы проверить
        письмо только на некоторых, передайте их в поле `accounts` тела запроса
        — в ответе и в результатах будут только они.
      operationId: startSpamCheck
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpamCheckStartRequest'
            examples:
              one:
                summary: Одна почта
                value:
                  accounts: inbox1@gmail.com
              many:
                summary: Несколько почт
                value:
                  accounts:
                    - inbox1@gmail.com
                    - inbox2@gmail.com
      responses:
        '200':
          description: Проверка создана
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpamCheckStartResponse'
              examples:
                all:
                  summary: Все почты
                  value:
                    check_id: a1b2c3d4e5f6
                    accounts:
                      - inbox1+tc_a1b2c3d4e5f6@gmail.com
                      - inbox2+tc_a1b2c3d4e5f6@gmail.com
                      - inbox3+tc_a1b2c3d4e5f6@gmail.com
                one:
                  summary: Одна почта
                  value:
                    check_id: a1b2c3d4e5f6
                    accounts:
                      - inbox1+tc_a1b2c3d4e5f6@gmail.com
        '400':
          description: Неверный формат `accounts` или тела запроса
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: accounts must be an email or a list of emails
        '401':
          description: Невалидный или отсутствующий API-ключ
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: Invalid or missing API key
        '404':
          description: >-
            Нет доступных тестовых аккаунтов или указанной почты нет среди
            доступных
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                no_accounts:
                  summary: Нет аккаунтов
                  value:
                    detail: No accounts available for this scope
                unknown_account:
                  summary: Почта недоступна
                  value:
                    detail: >-
                      Account(s) not available for this API key:
                      inbox9@gmail.com
components:
  schemas:
    SpamCheckStartRequest:
      type: object
      properties:
        accounts:
          description: >-
            Почты, на которых провести проверку: один адрес строкой или список.
            Регистр не важен, адрес с тегом `+tc_…` тоже принимается. Каждая
            почта должна быть среди доступных вашему ключу. Не указано —
            проверка по всем почтам.
          oneOf:
            - type: string
              format: email
            - type: array
              items:
                type: string
                format: email
          example: inbox1@gmail.com
    SpamCheckStartResponse:
      type: object
      required:
        - check_id
        - accounts
      properties:
        check_id:
          type: string
          description: Уникальный идентификатор проверки
          example: a1b2c3d4e5f6
        accounts:
          type: array
          description: Список тестовых адресов для отправки письма
          items:
            type: string
            format: email
          example:
            - inbox1+tc_a1b2c3d4e5f6@gmail.com
            - inbox2+tc_a1b2c3d4e5f6@gmail.com
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Описание ошибки
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API-ключ. Передаётся в заголовке `Authorization: Bearer <ваш_ключ>`.
        Ключ выдаётся администратором Taimly.

````

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