Public API GeTxt

Создание одно- и многостраничных записок через JSON API.

Базовый URL

https://getxt.online/api/v1

Обычная записка

POST /api/v1/shares
Content-Type: application/json

{
  "content": "# Заголовок\n\nТекст записки",
  "ttl": "1h",
  "password": "",
  "burn_after": null
}

ttl: 1h, 1d, 7d или 30d. Лимит burn_after — от 1 до 1000 успешных открытий. Максимальный общий размер текста — 512 КБ.

Многостраничная записка

POST /api/v1/shares
Content-Type: application/json

{
  "pages": [
    {
      "title": "Введение",
      "content": "# Начало\n\nПервая страница",
      "format": "markdown"
    },
    {
      "title": "Продолжение",
      "content": "## Вторая глава\n\nТекст второй страницы",
      "format": "markdown"
    }
  ],
  "ttl": "7d",
  "password": "",
  "burn_after": null
}

Допускается до 100 страниц. Ограничение 512 КБ применяется к сумме всех заголовков и страниц. Страница просмотра сама показывает кнопки «Назад» и «Вперёд». Одно открытие всей записи увеличивает счётчик просмотров один раз.

HTML

Для страницы можно указать format: "html". HTML проходит серверную очистку: разрешены текстовые теги, таблицы, ссылки и ограниченный набор inline-стилей. Скрипты, обработчики событий, iframe и медиа удаляются.

API-ключ

Authorization: Bearer gxt_your_key
# или
X-API-Key: gxt_your_key

Валидный ключ разрешает permanent: true и доверенный формат, который всё равно проходит безопасную HTML-очистку. Ключи создаются и отзываются в админ-панели.

Ответ создания

{
  "id": "Ab12Cd",
  "url": "https://getxt.online/Ab12Cd",
  "expires_at": 1770000000,
  "burn_after": null,
  "password_required": false,
  "content_type": "markdown",
  "page_count": 2
}

Мета-информация

GET /api/v1/shares/Ab12Cd/meta

Прочитать

POST /api/v1/shares/Ab12Cd/read
Content-Type: application/json

{"password": ""}

Для многостраничной записи ответ содержит массив pages. У каждой страницы есть index, title, content, content_type и готовый безопасный html.

Ошибки

400 bad_json | empty_content | empty_page | bad_pages | bad_ttl | bad_burn_after | bad_content_type
401 bad_password | bad_api_key
404 not_found
413 too_large
429 rate_limited
503 id_generation_failed