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

Быстрый старт

Отправьте задачу на преобразование PDF и получите результат за несколько минут.

В этом руководстве используются cURL и эндпоинт преобразования PDF в Markdown. Тот же шаблон отправки и опроса применим и к преобразованию EPUB.

1. Создайте API-ключ

Создайте API-ключ в OOMOL Console. Храните его на своём сервере или в менеджере секретов; никогда не включайте его в браузерный бандл или публичное клиентское приложение.

2. Отправьте задачу на преобразование

Замените пример ключа и URL PDF, затем отправьте запрос на эндпоинт отправки.

bash

curl --request POST "https://fusion-api.oomol.com/v1/pdf-transform-markdown/submit" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "pdfURL": "https://pdfcraft.ai/examples/api-quickstart.pdf",
    "model": "gundam"
  }'

Ответ содержит sessionID, который является идентификатором задачи. Сохраните его вместе с собственной записью о задаче и используйте его вместо TASK_ID ниже, чтобы повторные попытки и загрузки оставались отслеживаемыми.

3. Опрашивайте результат

Запрашивайте эндпоинт результата до тех пор, пока статус не станет completed или failed, либо пока не будет достигнуто максимальное количество попыток или крайний срок. Рассматривайте любой ответ, отличный от 2xx, как ошибку и прекращайте опрос, если state неизвестен. Начните с короткой задержки и увеличивайте интервал между попытками для более длинных документов.

bash

curl --request GET "https://fusion-api.oomol.com/v1/pdf-transform-markdown/result/TASK_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

Считайте состояние задачи из state. Когда оно равно completed, скачайте сгенерированный файл из data.downloadURL; когда оно равно failed, зафиксируйте и обработайте возвращённую причину сбоя.

Дальнейшие шаги

Ознакомьтесь с обзором API для аутентификации, состояний задач и повторных попыток.
Используйте API Reference, когда вам нужны детали запросов и ответов на уровне полей.

Запуск полного примера

Скачайте и проверьте пример Python 3. Он читает PDF_CRAFT_API_KEY из окружения, отправляет одну конвертацию с возможным расходом кредитов, сохраняет ID задачи и проверяет результат с ограничением времени. После прерывания продолжайте ту же задачу, не отправляя её повторно.

bash

python3 api-quickstart.py
python3 api-quickstart.py --resume pdf-craft-task.json