Ошибки

Формат ошибок

Все ошибки возвращаются с соответствующим HTTP-статусом и JSON-телом:

{
  "detail": "Описание ошибки"
}

401 — Invalid or missing API key

Проблема с аутентификацией.

{
  "detail": "Invalid or missing API key"
}

Возможные причины:

Причина	Решение
Заголовок `Authorization` отсутствует	Добавьте заголовок `Authorization: Bearer YOUR_API_KEY`
Неверный формат заголовка	Убедитесь в формате `Bearer <ключ>` (с пробелом после `Bearer`)
Ключ невалиден или истёк	Запросите новый ключ у администратора

Пример правильного запроса:

curl -X POST https://taimly.net/api/spam-check/start \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

400 — Unknown field(s)

В параметре fields есть неизвестное имя поля. В сообщении перечислены допустимые.

{
  "detail": "Unknown field(s): foo. Allowed: sender_name, sender_email, subject, reply_to, smtp, sender_ip, ptr, ip_type, spf, dkim, dmarc, has_attachments, body_text, body_html, raw"
}

Список полей — в разделе Данные письма.

404 — No accounts available for this scope

Нет активных тестовых аккаунтов для проверки.

{
  "detail": "No accounts available for this scope"
}

Эта ошибка возникает при вызове POST /api/spam-check/start, если в системе нет доступных Gmail-аккаунтов. Обратитесь к администратору.

400 — accounts must be an email or a list of emails

Поле accounts в теле POST /api/spam-check/start — не строка и не список строк. Если тело вообще не JSON, вернётся Invalid JSON body.

{
  "detail": "accounts must be an email or a list of emails"
}

404 — Account(s) not available for this API key

Почты из accounts нет среди тестовых аккаунтов, доступных вашему ключу. В сообщении перечислены такие адреса.

{
  "detail": "Account(s) not available for this API key: inbox9@gmail.com"
}

404 — Check not found or expired

Проверка не найдена или истекла.

{
  "detail": "Check not found or expired"
}

Эта ошибка возникает при вызове GET /api/spam-check/{check_id} и GET /api/spam-check/{check_id}/raw. Возможные причины:

Причина	Решение
Неверный `check_id`	Используйте `check_id` из ответа `POST /api/spam-check/start`
Проверка истекла (прошло более 30 минут)	Создайте новую проверку
Проверка создана другим API-ключом	Запрашивайте результаты тем же ключом, которым запускали проверку

Через 5 минут недополученная проверка получает статус timeout, но её результаты и данные писем доступны 30 минут после старта.

404 — ошибки `/raw`

GET /api/spam-check/{check_id}/raw дополнительно может вернуть:

Сообщение	Причина
`Account not found in this check`	`email` не относится к тестовым аккаунтам этой проверки
`Email not received yet`	Письмо на этот аккаунт ещё не пришло
`Original source not available`	Оригинал письма не сохранился (бывает редко, например у писем крупнее 25 МБ)

Если не передан email, вернётся 400 email required.

Обработка ошибок в коде

import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://taimly.net"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}

response = requests.post(f"{BASE_URL}/api/spam-check/start", headers=HEADERS)

if response.status_code == 401:
    print("Ошибка: невалидный API-ключ")
elif response.status_code == 404:
    print("Ошибка: нет доступных аккаунтов")
elif response.ok:
    data = response.json()
    print(f"Проверка создана: {data['check_id']}")
else:
    print(f"Неизвестная ошибка: {response.status_code}")

const response = await fetch(`${BASE_URL}/api/spam-check/start`, {
  method: "POST",
  headers: { "Authorization": `Bearer ${API_KEY}` }
});

if (response.status === 401) {
  console.error("Ошибка: невалидный API-ключ");
} else if (response.status === 404) {
  console.error("Ошибка: нет доступных аккаунтов");
} else if (response.ok) {
  const data = await response.json();
  console.log(`Проверка создана: ${data.check_id}`);
}

Таблица всех ошибок

Код	Сообщение	Эндпоинт	Описание
`400`	Unknown field(s): …	`GET /{check_id}`	Неизвестное поле в `fields`
`400`	email required	`GET /{check_id}/raw`	Не передан `email`
`401`	Invalid or missing API key	Все	Проблема с API-ключом
`400`	accounts must be an email or a list of emails	`POST /start`	Неверный формат `accounts`
`400`	Invalid JSON body	`POST /start`	Тело запроса — не JSON
`404`	No accounts available for this scope	`POST /start`	Нет тестовых аккаунтов
`404`	Account(s) not available for this API key: …	`POST /start`	Почта из `accounts` недоступна ключу
`404`	Check not found or expired	`GET /{check_id}`, `GET /{check_id}/raw`	Проверка не найдена, истекла или чужая
`404`	Account not found in this check	`GET /{check_id}/raw`	Аккаунт не из этой проверки
`404`	Email not received yet	`GET /{check_id}/raw`	Письмо ещё не пришло
`404`	Original source not available	`GET /{check_id}/raw`	Оригинал не сохранился

Начало работы

Справочник

Временные почты

Формат ошибок

401 — Invalid or missing API key

400 — Unknown field(s)

404 — No accounts available for this scope

400 — accounts must be an email or a list of emails

404 — Account(s) not available for this API key

404 — Check not found or expired

404 — ошибки `/raw`

Обработка ошибок в коде

Таблица всех ошибок

​Формат ошибок

​401 — Invalid or missing API key

​400 — Unknown field(s)

​404 — No accounts available for this scope

​400 — accounts must be an email or a list of emails

​404 — Account(s) not available for this API key

​404 — Check not found or expired

​404 — ошибки /raw

​Обработка ошибок в коде

​Таблица всех ошибок

Формат ошибок

401 — Invalid or missing API key

400 — Unknown field(s)

404 — No accounts available for this scope

400 — accounts must be an email or a list of emails

404 — Account(s) not available for this API key

404 — Check not found or expired

404 — ошибки `/raw`

Обработка ошибок в коде

Таблица всех ошибок