Поделиться через


PDFco

PDF.co — это набор средств PDF из извлечения данных в средство синтаксического анализа документов. Создание PDF, чтение неструктурированных PDF-файлов, заливка PDF-форм, добавление текста и изображений в PDF, разделение PDF, слияние PDF, преобразование таблиц PDF в CSV, JSON, XML и многое другое.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя поддержка PDF.co
URL https://support.bytescout.com
Адрес электронной почты plugins@bytescout.com
Метаданные соединителя
Publisher PDF.co
Веб-сайт https://pdf.co/
Политика конфиденциальности https://pdf.co/pages/legal/privacy
Категории Продуктивность; Данные

соединитель PDF.co предоставляет операции слияния PDF, Split PDF, HTML на PDF, URL-адрес в ФОРМАТЕ PDF и изменения PDF. Слияние PDF поддерживает объединение различных типов документов в формат PDF. Для изменения PDF-файла она поддерживает добавление текста и изображений в PDF-файлы, а также заполнение форм PDF.

Предпосылки

PDF.co требуется ключ API для проверки подлинности запросов.

Получение учетных данных

PDF.co ключ API можно получить путем регистрации с помощью PDF.co.

  • Войдите в учетную запись PDF.co по адресу https://app.pdf.co
  • После входа в ключ API можно найти в разделе "Просмотр ключа API".

Начало работы с соединителем

соединитель PDF.co состоит из следующих действий.

  • HTML-файл в PDF

    Действие HTML в PDF преобразует необработанный формат HTML в формат PDF. Помимо этого, можно также настроить дополнительные параметры, такие как размер выходной бумаги, ориентация страницы PDF, поля, настраиваемые верхние и нижние колонтитулы и т. д.

  • URL-адрес в ФОРМАТЕ PDF

    Как предполагается, URL-адрес в действие PDF преобразует URL-адрес веб-сайта в PDF-документ. Мы можем настроить дополнительные параметры для полей выходной страницы, ориентации, колонтитула и т. д.

  • Разделение PDF

    Это действие — разделить входной PDF-файл на несколько страниц. Необходимо указать параметр Pages для количества выходных страниц.

  • Слияние PDF

    Это действие объединяет документы с PDF-файлом. Здесь документы могут иметь различные форматы, такие как pdf, doc, text, excel, zip и т. д. Для входного параметра "URL-адрес" требуется URL-адреса разделенных запятыми документов.

  • Заливка PDF

    Действие заливки PDF изменяет существующий PDF-документ. С помощью этого действия можно добавить текст и изображения в существующий PDF-файл, а также заполнить поля форм PDF. Необходимо передать значения в определенном формате. Дополнительные сведения см. в pdf.co официальной документации.

Известные проблемы и ограничения

В этой начальной версии соединителя PDF.co рассматриваются только несколько функций PDF.co. Одна из функций, отсутствующих в этой начальной версии, заключается в проверке состояния асинхронного задания и получении завершенных результатов задания.

Распространенные ошибки и средства устранения неполадок

  • URL-адрес ввода, переданный в действие PDF.co, должен быть допустимым и общедоступным URL-адресом.

  • Если PDF.co запрос возвращает 401 - несанкционированный результат, убедитесь, что указан действительный ключ API PDF.co.

  • Все запросы вычитают PDF.co кредиты на основе обработки запросов. Таким образом, если у вашей учетной записи PDF.co недостаточно кредитов, это приведет к ошибке.

Часто задаваемые вопросы

Обратитесь к PDF.co базе знаний для всех ЦС.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring КЛЮЧ API для этой конечной точки True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

HTML-файл в PDF

Преобразуйте фрагмент кода HTML в полнофункциональный PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-html/index.html документации по API.

PDF To JSON (AI Powered)

Преобразуйте PDF-файлы и сканированные изображения в представление JSON с сохраненным текстом, шрифтами, изображениями, векторами и форматированием. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta документации по API.

PDF To Text (без макета и ocr)

Преобразование PDF-файла в обычный текст без сохранения макета и поддержки OCR. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple документации по API.

Pdf To Text (с макетом и ocr)

Преобразование PDF-файлов и отсканированных изображений в текст с сохранением макета. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-text/index.html документации по API.

PDF из CSV

Преобразование CSV-документа в PDF-файл. Также работает с входными данными XLS или XLSX. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv документации по API.

PDF из документа (Doc, DocX, RTF, TXT, XPS)

Преобразуйте ФАЙЛЫ DOC, DOCX, RTF, TXT, XPS в PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc документации по API.

PDF-файл в CSV

Преобразуйте PDF-файлы и сканированные изображения в представление CSV с макетом, столбцами, строками и таблицами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-csv/index.html документации по API.

PDF-файл в JPG

Преобразование PDF в JPG. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg документации по API.

PDF-файл в JSON

Преобразуйте PDF-файлы и сканированные изображения в представление JSON с сохраненным текстом, шрифтами, изображениями, векторами и форматированием. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-json/index.html документации по API.

PDF-файл в PNG

Преобразование PDF в PNG. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png документации по API.

PDF-файл в TIFF

Преобразование изображений TIFF в формате PDF в высококачественное. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff документации по API.

PDF-файл в WEBP

Преобразование PDF в WEBP. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp документации по API.

PDF-файл в XLS

Преобразуйте PDF-файлы и сканированные изображения в электронную таблицу с сохраненными макетами и шрифтами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls документации по API.

PDF-файл в XLSX

Преобразуйте PDF-файлы и сканированные изображения в электронную таблицу с сохраненными макетами и шрифтами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx документации по API.

PDF-файл в XML

Преобразование PDF-файла в XML с информацией о текстовом значении, таблицах, шрифтах, изображениях, позициях объектов. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-xml/index.html документации по API.

PDF-файл в отсканированное PDF-файл

Преобразуйте PDF-файл в отсканированный PDF-файл. Результат PDF совпадает с тем, что вы печатали, а затем сканировали PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable документации по API.

PDF-файл из изображения

Создайте PDF-файл из одного или нескольких изображений JPG, PNG, TIFF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-image/index.html документации по API.

PDF-файл из электронной почты

Преобразуйте код электронной почты (MSG или EML) в PDF. Извлекает вложения (если таковые) из входного сообщения электронной почты и внедряется в PDF в виде вложений pdf. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-email/index.html документации по API.

PDF-файл из электронной таблицы

Создайте PDF-файл из электронной таблицы XLS, XLSX. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf документации по API.

URL-адрес в ФОРМАТЕ PDF

Создание PDF-файла из URL-адреса. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-url/index.html документации по API.

Генератор штрихкодов

Создайте высококачественные изображения штрихкодов. Поддерживает QR-код, Datamatrix, Код 39, Код 128, PDF417 и многие другие типы штрихкодов. Подробные рекомендации см. в https://developer.pdf.co/api/barcode-generator/index.html документации по API.

Добавление безопасности PDF

Добавьте ограничения паролей и безопасности в существующий PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add документации по API.

Добавление текста, изображений, полей формы в PDF

Добавьте текст, изображения, подписи в pdf. Заполните поля формы PDF и создайте pdf-файл из шаблонов. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-add/index.html документации по API.

Извлечение вложений PDF

Извлеките вложения из входного PDF-документа. Подробные рекомендации см. в https://developer.pdf.co/api/extract-attachments/index.html документации по API.

Извлечение вложений по электронной почте

Извлеките вложения электронной почты с основными сведениями по электронной почте. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments документации по API.

Классификатор документов

Автоматическая классификация входящих документов на основе правил на основе ключевых слов. Например, можно определить правила, чтобы найти, какой поставщик предоставил документ, чтобы найти соответствующий шаблон. Подробные рекомендации см. в https://developer.pdf.co/api/document-classifier/index.html документации по API.

Отправка электронной почты с помощью вложений

Отправка сообщения электронной почты с вложениями. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html документации по API.

Поворот PDF-страниц

Смена PDF-страниц. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-rotate-pages/index.html документации по API.

Поворот PDF-страниц (авто)

Использует ИИ для автоматического исправления поворота страниц внутри сканированного PDF-файла на основе анализа текста. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto документации по API.

Поиск в формате PDF и замена текста изображением

Замените определенный текст в PDF-документе изображением. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image документации по API.

Поиск и замена текста в формате PDF

Измените PDF-файл, выполнив поиск определенного текста и заменив его новым текстом. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text документации по API.

Поиск и удаление текста PDF из PDF

Выполните поиск текста в ФОРМАТЕ PDF и удалите найденный текст из PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-delete-text/index.html документации по API.

Проверка фоновых заданий

Проверяет состояние фонового задания, созданного ранее с помощью API PDF.co. Подробные рекомендации см. в https://developer.pdf.co/api/background-job-check/index.html документации по API.

Разделение PDF

Разделяет страницы из PDF-документа на несколько новых PDF-файлов с помощью номеров страниц и диапазонов страниц. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-split/index.html документации по API.

Разделение PDF (дополнительно)

Разделение PDF-файлов на несколько PDF-файлов по текстовому поиску (поддерживает регулярные выражения) или штрихкоду. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 документации по API.

Сведения о электронной почте

Получение сведений электронной почты, таких как отправитель или получатель, тема, текст и т. д. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode документации по API.

Сжатие и оптимизация PDF

Оптимизируйте PDF-документ, чтобы уменьшить его размер. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-optimize/index.html документации по API.

Слияние PDF

Слияние PDF-файла из двух или нескольких PDF-файлов в новое. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-merge/index.html документации по API.

Слияние PDF (дополнительно)

Слияние PDF-файла из двух или нескольких pdf-файлов, doc, xls, изображений, даже zip с документами и изображениями в новый PDF-файл. Поддерживает zip, docx, xls, xlsx, rtf, txt, png, jpg. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 документации по API.

Создание отсканированного PDF-файла в доступный для поиска текста

Преобразуйте PDF и отсканированные изображения JPG, PNG в текстовый PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable документации по API.

Средство синтаксического анализа документов

Средство синтаксического анализа документов документов может автоматически анализировать PDF, JPG и PNG-документы для извлечения полей, таблиц, значений и штрихкодов из счетов, инструкций, заказов и других документов PDF и сканированных документов. Подробные рекомендации см. в https://developer.pdf.co/api/document-parser/index.html документации по API.

Средство чтения сведений PDF

Получите подробные сведения о PDF-документе, его свойствах и разрешениях безопасности. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-info-reader/index.html документации по API.

Средство чтения сведений о формах PDF

Получение сведений о заполняемых полях в PDF-файле формы. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-forms-info-reader/index.html документации по API.

Средство чтения штрихкодов

Чтение штрихкодов из изображений и PDF. Может читать все популярные типы штрихкодов из QR-кода и кода 128, EAN в Datamatrix, PDF417, GS1 и многих других штрихкодов. Подробные рекомендации см. в https://developer.pdf.co/api/barcode-reader/index.html документации по API.

Страницы удаления PDF

Удаление страниц в ФОРМАТЕ PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-delete-pages/index.html документации по API.

Таблица поиска PDF

Анализ документов на основе искусственного интеллекта может сканировать документ для таблиц и возвращать массив таблиц на страницах с координатами и сведениями о столбцах, обнаруженных в этих таблицах. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table документации по API.

Текст поиска PDF

Поиск текста в ФОРМАТЕ PDF и получение координат. Поддерживает регулярные выражения. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-find/index.html документации по API.

Удаление PDF-файла

Удалите пароль и безопасность из существующих PDF-файлов. Подробные рекомендации см. в https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove документации по API.

Электронная таблица в CSV

Преобразуйте XLS/XLSX в csv-файл разделенных запятыми значений. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv документации по API.

Электронная таблица в HTML

Преобразуйте XLS/XLSX в HTML-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html документации по API.

Электронная таблица в JSON

Преобразуйте XLS/XLSX в JSON-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json документации по API.

Электронная таблица в TXT

Преобразуйте XLS/XLSX или CSV-файл в текстовый файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt документации по API.

Электронная таблица в XML

Преобразуйте XLS/XLSX или CSV-файл в XML-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml документации по API.

HTML-файл в PDF

Преобразуйте фрагмент кода HTML в полнофункциональный PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-html/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
HTML
html True html

Входной HTML-код для преобразования.

Имя
name string

Базовое имя файла для новых PDF-файлов.

поля;
margins string

Переопределите поля по умолчанию с настраиваемыми значениями (порядок равен top right bottom left). Вы можете задать все поля: 10px, 5mm5in для всех сторон.

Размер бумаги
paperSize string

Выберите размер бумаги PDF. Может быть буквой, юридической, таблоидой, реестром, A0, A1, A2, A3, A4, A5, A6 или пользовательским размером. Настраиваемый размер можно задать в пикселях (пикселях), мм или в (дюймах) с шириной и высотой, разделенной пробелом: 200 300, 200 пикселей 300 пикселей, 200mm 300mm, 20cm 30cm или 6in 8in.

Ориентация
orientation string

Ориентация страницы PDF.

Печать фона
printBackground boolean

Включение или отключение печати фона документа

Header
header html

Установите значение HTML для применения заголовка на каждой странице в заголовке.

Нижний колонтитул
footer html

Установите значение HTML для применения нижнего колонтитула на каждой странице в нижней части.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Код состояния
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

PDF To JSON (AI Powered)

Преобразуйте PDF-файлы и сканированные изображения в представление JSON с сохраненным текстом, шрифтами, изображениями, векторами и форматированием. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Встроенный
inline boolean
Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
Тело
body object

body

URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF To Text (без макета и ocr)

Преобразование PDF-файла в обычный текст без сохранения макета и поддержки OCR. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Встроенный
inline boolean
Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Возвращаемое значение

Имя Путь Тип Описание
Тело
body string

body

URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Pdf To Text (с макетом и ocr)

Преобразование PDF-файлов и отсканированных изображений в текст с сохранением макета. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-text/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Встроенный
inline boolean
Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
Тело
body string

body

URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF из CSV

Преобразование CSV-документа в PDF-файл. Также работает с входными данными XLS или XLSX. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF из документа (Doc, DocX, RTF, TXT, XPS)

Преобразуйте ФАЙЛЫ DOC, DOCX, RTF, TXT, XPS в PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в CSV

Преобразуйте PDF-файлы и сканированные изображения в представление CSV с макетом, столбцами, строками и таблицами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-csv/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Встроенный
inline boolean
Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
Тело
body string

body

URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в JPG

Преобразование PDF в JPG. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

inline
inline boolean

inline

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в JSON

Преобразуйте PDF-файлы и сканированные изображения в представление JSON с сохраненным текстом, шрифтами, изображениями, векторами и форматированием. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-json/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Встроенный
inline boolean
Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
Тело
body object

body

URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в PNG

Преобразование PDF в PNG. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

inline
inline boolean

inline

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в TIFF

Преобразование изображений TIFF в формате PDF в высококачественное. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

inline
inline boolean

inline

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в WEBP

Преобразование PDF в WEBP. Высококачественная отрисовка. Кроме того, отлично подходит для создания эскизов и предварительных версий. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

inline
inline boolean

inline

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в XLS

Преобразуйте PDF-файлы и сканированные изображения в электронную таблицу с сохраненными макетами и шрифтами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в XLSX

Преобразуйте PDF-файлы и сканированные изображения в электронную таблицу с сохраненными макетами и шрифтами. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в XML

Преобразование PDF-файла в XML с информацией о текстовом значении, таблицах, шрифтах, изображениях, позициях объектов. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-to-xml/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Встроенный
inline boolean
Язык OCR
lang string

Задайте язык для OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR здесь (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Разворачивать
unwrap string

Распаковка строк в одну строку в ячейках таблицы при включении lineGrouping.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Прямоугольник
rect string

Определяет координаты для извлечения, например 51.8, 114.8, 235.5, 204.0. Используйте PDF.co в формате PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) для получения или измерения координат PDF.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Имя
name string

Имя файла для созданных выходных данных

Группирование строк
lineGrouping string

Группирование строк в ячейках таблицы. Установите значение 1, чтобы включить группирование.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Тело
body string

body

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл в отсканированное PDF-файл

Преобразуйте PDF-файл в отсканированный PDF-файл. Результат PDF совпадает с тем, что вы печатали, а затем сканировали PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Пароль
password string

Пароль PDF-файла

Асинхронность
async boolean

Задайте значение Async значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck для проверки состояния процесса и извлечения выходных данных, а также для выполнения других задач, не ожидая завершения этого процесса.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл из изображения

Создайте PDF-файл из одного или нескольких изображений JPG, PNG, TIFF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-image/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL-адреса
url True string

URL-адрес исходного файла. Укажите несколько URL-адресов в формате с разделителями-запятыми. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл из электронной почты

Преобразуйте код электронной почты (MSG или EML) в PDF. Извлекает вложения (если таковые) из входного сообщения электронной почты и внедряется в PDF в виде вложений pdf. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-email/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Внедрение вложений
embedAttachments boolean

Установите значение true, чтобы автоматически внедрять все вложения из исходных входных MSG или EML-файлов в окончательный выходной PDF-файл. Установите для него значение false, если вы не хотите внедрять вложения, поэтому оно преобразует только текст входного сообщения электронной почты.

Преобразование вложений
convertAttachments boolean

Установите значение false, если вы не хотите преобразовывать вложения из исходного сообщения электронной почты и хотите внедрить их в качестве исходных файлов (как внедренные вложения PDF). Преобразует вложения, поддерживаемые API (DOC, DOCx, HTML, PNG, JPG и т. д.) в PDF и объединяется в выходной PDF-файл. Не поддерживаемые типы файлов добавляются в виде вложений PDF (Adobe Reader или другого средства просмотра может потребоваться для просмотра вложений PDF).

Поля
margins string

задайте поля стиля CSS, такие как 10px, 5mm, 5in для всех сторон или 5px 5px 5px 5px 5px (порядок полей сверху, справа, вниз, слева).

Размер бумаги
paperSize string

Буква задана по умолчанию. Может быть буквой, юридической, таблоидой, реестром, A0, A1, A2, A3, A4, A5, A6 или пользовательским размером. Настраиваемый размер можно задать в пикселях (пикселях), мм или в (дюймах) с шириной и высотой, разделенной пробелом: 200 300, 200 пикселей 300 пикселей, 200mm 300mm, 20cm 30cm или 6in 8in.

Ориентация
orientation string
Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

PDF-файл из электронной таблицы

Создайте PDF-файл из электронной таблицы XLS, XLSX. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

URL-адрес в ФОРМАТЕ PDF

Создание PDF-файла из URL-адреса. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-from-url/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

Ссылка на входной HTML-файл или страницу веб-сайта для преобразования. Вы можете передать ссылку на файл из Google Drive, Dropbox или другой веб-файловой службы, которая может создавать ссылки, доступные для общего доступа.

Поля
margins string

Поля, используемые в выходном документе. Задайте для полей стиля css, таких как 10px, 5mm, 5in для всех сторон или 5px 5px 5px 5px (порядок полей сверху, справа, вниз, слева).

Размер бумаги
paperSize string

Буква задана по умолчанию. Может быть буквой, юридической, таблоидой, реестром, A0, A1, A2, A3, A4, A5, A6 или пользовательским размером. Настраиваемый размер можно задать в пикселях (пикселях), мм или в (дюймах) с шириной и высотой, разделенной пробелом: 200 300, 200 пикселей 300 пикселей, 200mm 300mm, 20cm 30cm или 6in 8in.

Ориентация
orientation string

Ориентация выходной страницы

Печать фона
printBackground boolean

Включение или отключение печати фона документа

Header
header html

Установите значение HTML для применения заголовка на каждой странице в заголовке.

Нижний колонтитул
footer html

Установите значение HTML для применения нижнего колонтитула на каждой странице в нижней части.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Код состояния
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Генератор штрихкодов

Создайте высококачественные изображения штрихкодов. Поддерживает QR-код, Datamatrix, Код 39, Код 128, PDF417 и многие другие типы штрихкодов. Подробные рекомендации см. в https://developer.pdf.co/api/barcode-generator/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
name string

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой /job/check, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Ценность
value True string

Задайте строковое значение для кодирования внутри штрихкода.

Тип
type True string

Задайте тип штрихкода QRCode По умолчанию.

Изображение украшения
decorationImage string

Задайте для этого изображение, которое нужно вставить логотип в QR-Code штрихкоде.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучение PDF.co базы https://developer.pdf.co/api/profiles/index.html знаний для примеров профилей

Возвращаемое значение

Имя Путь Тип Описание
JobId
jobId string

jobId

URL
url string

URL-адрес

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Добавление безопасности PDF

Добавьте ограничения паролей и безопасности в существующий PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Пароль владельца
ownerPassword True string

Главный пароль владельца, используемый для шифрования документов и для настройки или удаления ограничений.

Пароль пользователя
userPassword string

Необязательный пароль пользователя будет запрашиваться для просмотра и печати документа.

Алгоритм шифрования
encryptionAlgorithm string

Алгоритм шифрования. Допустимые значения: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. рекомендуется использовать AES_128bit или более поздней версии.

Разрешить поддержку специальных возможностей
allowAccessibilitySupport boolean

Разрешить или запретить извлечение содержимого для потребностей специальных возможностей. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить документ сборки
allowAssemblyDocument boolean

Разрешить или запретить сборку документа. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить печать документа
allowPrintDocument boolean

Разрешить или запретить печать PDF-документа. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить заполнение форм
allowFillForms boolean

Разрешить или запретить заполнение полей интерактивной формы (включая поля подписи) в pdf-документах. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить изменение документа
allowModifyDocument boolean

Разрешить или запретить изменение PDF-документа. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить извлечение содержимого
allowContentExtraction boolean

Разрешить или запретить копирование содержимого из PDF-документа. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Разрешить изменение заметок
allowModifyAnnotations boolean

Разрешить или запретить взаимодействие с текстовыми заметками и формами в PDF-документе. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Качество печати
printQuality string

Разрешено качество печати. Допустимые значения: HighResolution, LowResolution. Примечание. Это ограничение применяется при вводе userPassword (при наличии). Это ограничение не применяется, если пользователь вводит пароль владельца.

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Добавление текста, изображений, полей формы в PDF

Добавьте текст, изображения, подписи в pdf. Заполните поля формы PDF и создайте pdf-файл из шаблонов. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-add/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес входного PDF-документа

Строка примечаний
annotationsString string

Строки заметок, добавляемые в PDF-документ. Формат должен иметь вид x;y; страница; текст". Дополнительные форматы и примеры см. в PDF.co документации.

Строка изображений
imagesString string

Изображения, добавляемые в PDF-документ. Формат должен иметь вид x;y; страница; urltoimage; связь; Ширина; высота". Дополнительные форматы и примеры см. в PDF.co документации.

Строка полей
fieldsString string

Заполните поля формы PDF. Формат должен быть похож на "page; fieldName; значение". Дополнительные форматы и примеры см. в PDF.co документации.

Имя
name string

Имя выходного PDF-файла

Встроенный
inline boolean

Определяет, следует ли возвращать выходные данные в ответе или ссылаться на выходной файл.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Этот параметр можно использовать для настройки дополнительных конфигураций для точной настройки и включения дополнительных параметров. Посетите PDF.co базу знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей и многое другое.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Код состояния
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Извлечение вложений PDF

Извлеките вложения из входного PDF-документа. Подробные рекомендации см. в https://developer.pdf.co/api/extract-attachments/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного PDF-документа

Встроенный
inline boolean

Определяет, следует ли возвращать выходные данные в ответе или ссылаться на выходной файл.

Имя
name string

Базовое имя файла для новых PDF-файлов

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Создает фоновое задание обработки.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Численность
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Состояние
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Извлечение вложений по электронной почте

Извлеките вложения электронной почты с основными сведениями по электронной почте. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

От
body.from string
Тема
body.subject string
Текст (HTML)
body.bodyHtml string
Текст (текст)
body.bodyText string
attachments
body.attachments array of object
Имя файла
body.attachments.filename string
contentid
body.attachments.contentid string

Идентификатор содержимого

URL-адрес
body.attachments.url string

URL

filesizeinbytes
body.attachments.filesizeinbytes integer

Размер файла (в байтах)

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Классификатор документов

Автоматическая классификация входящих документов на основе правил на основе ключевых слов. Например, можно определить правила, чтобы найти, какой поставщик предоставил документ, чтобы найти соответствующий шаблон. Подробные рекомендации см. в https://developer.pdf.co/api/document-classifier/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Правила (в формате CSV)
rulescsv string

Определите пользовательские правила классификации в формате CSV. Правила находятся в формате CSV, где каждая строка содержит "имя класса, логика (AND или OR (по умолчанию)) и ключевые слова", разделенные запятой. Каждая строка разделена символом \n.

URL-адрес правил (в формате CSV)
rulescsvurl string

Вместо встроенного CSV можно использовать этот параметр и задать URL-адрес CSV-файла с правилами классификации. Это полезно, если у вас есть отдельный разработчик, работающий над правилами CSV.

Учет регистра
caseSensitive boolean

Определяет, учитывает ли ключевые слова в правилах регистр или нет.

Встроенный
inline boolean

Задайте значение true, чтобы возвращать результаты внутри ответа. В противном случае конечная точка вернет ссылку на созданный выходной файл.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

classes
body.classes array of object
Class
body.classes.class string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Отправка электронной почты с помощью вложений

Отправка сообщения электронной почты с вложениями. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

От
from True string

Поле From с именем отправителя и электронной почтой. Пример: Джон Доу john@example.com

Кому
to True string

Поле "To" с именем получателя и электронной почтой. Пример: Партнер partner@example.com

Тема
subject True string

Тема исходящего сообщения электронной почты

Текст (в текстовом формате)
bodytext string

Обычная текстовая версия исходящего сообщения электронной почты.

Текст (в формате HTML)
bodyhtml string

HTML-версия исходящего сообщения электронной почты.

SMTP-сервер
smtpserver True string

АДРЕС SMTP-сервера

SMTP-порт
smtpport True string

SMTP-порт

Имя пользователя SMTP
smtpusername True string

Имя пользователя SMTP-сервера

Пароль SMTP
smtppassword True string

Пароль SMTP-сервера, если вы используете Gmail, необходимо создать пароль для конкретного приложения, как показано в https://support.google.com/accounts/answer/185833инструкции.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Поворот PDF-страниц

Смена PDF-страниц. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-rotate-pages/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

угол
angle integer

Угол в градусах. Поддерживаемые значения 90, 180 и 270.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Поворот PDF-страниц (авто)

Использует ИИ для автоматического исправления поворота страниц внутри сканированного PDF-файла на основе анализа текста. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

язык OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR находится на ).https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Поиск в формате PDF и замена текста изображением

Замените определенный текст в PDF-документе изображением. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Учитывает регистр
caseSensitive boolean
Строка поиска
searchString True string

Замена одного текста. Слово или фраза для замены

Замена URL-адреса изображения
replaceImage True string

URL-адрес изображения для вставки в документ.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Асинхронная
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем проверки заданий, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Включена ли regex?
regex boolean
Ограничение замены
replacementLimit integer

Ограничение количества поисковых запросов и замены для каждого элемента. Значение по умолчанию равно 0, что означает неограниченный поиск и замены, поэтому каждое найденное вхождение будет заменено.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Пароль
password string

Пароль PDF-файла

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор задания
jobId string

jobId

URL
url string

URL-адрес

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Поиск и замена текста в формате PDF

Измените PDF-файл, выполнив поиск определенного текста и заменив его новым текстом. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

searchStrings
searchStrings True array of string

Строки поиска

replaceStrings
replaceStrings array of string

Строки замены

Учитывается ли регистр?
caseSensitive boolean
Ограничение замены
replacementLimit integer

Ограничение количества поисковых запросов и замены для каждого элемента. Значение по умолчанию равно 0, что означает неограниченный поиск и замены, поэтому каждое найденное вхождение будет заменено.

Включена ли regex?
regex boolean

Задайте значение true, чтобы использовать регулярное выражение для строк поиска.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Пароль
password string

Пароль PDF-файла

Имя
name string

Имя файла для созданных выходных данных

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Число страниц
pageCount integer
Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

Поиск и удаление текста PDF из PDF

Выполните поиск текста в ФОРМАТЕ PDF и удалите найденный текст из PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-search-and-delete-text/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

searchStrings
searchStrings True array of string

searchStrings

Учитывает регистр
caseSensitive boolean
Включена ли regex?
regex boolean

Задайте значение true, чтобы использовать регулярное выражение для строк поиска.

Ограничение замены
replacementLimit integer

Ограничение количества поисковых запросов и замены для каждого элемента. Значение по умолчанию равно 0, что означает неограниченный поиск и замены, поэтому каждое найденное вхождение будет заменено.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Имя
name string

Имя файла для созданных выходных данных

Пароль
password string

Пароль PDF-файла

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Проверка фоновых заданий

Проверяет состояние фонового задания, созданного ранее с помощью API PDF.co. Подробные рекомендации см. в https://developer.pdf.co/api/background-job-check/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор задания
jobid True string

PDF.co идентификатор фонового задания

Возвращаемое значение

Имя Путь Тип Описание
Состояние
status string

статус

URL-адрес
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Продолжительность
duration integer

duration

Разделение PDF

Разделяет страницы из PDF-документа на несколько новых PDF-файлов с помощью номеров страниц и диапазонов страниц. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-split/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного PDF-документа

Страницы
pages True string

Разделенный запятыми список индексов страниц (или диапазонов) для разделения на. Первая страница — 1 (одна). Пример: "1,2-5,7-". Особые случаи: извлечение каждой страницы в отдельные PDF-файлы.*

Встроенный
inline boolean

Определяет, следует ли возвращать выходные данные в ответе или ссылаться на выходной файл.

Имя
name string

Базовое имя файла для новых PDF-файлов

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Создает фоновое задание обработки.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Состояние
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Разделение PDF (дополнительно)

Разделение PDF-файлов на несколько PDF-файлов по текстовому поиску (поддерживает регулярные выражения) или штрихкоду. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного PDF-документа

Строка поиска
searchString True string

Текст для поиска на страницах. Также можно выполнить поиск по штрихкоду, чтобы получить дополнительные сведения о посещении https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2

Исключить ключевые страницы
excludeKeyPages boolean

Задайте значение true, если требуется исключить страницы, в которых найден текст

regexSearch
regexSearch boolean

Задайте значение true, чтобы включить регулярные выражения для строки поиска

caseSensitive
caseSensitive boolean

Задайте значение true, чтобы включить поиск с учетом регистра.

Язык OCR
lang string

язык OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR находится на ).https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Встроенный
inline boolean

Определяет, следует ли возвращать выходные данные в ответе или ссылаться на выходной файл.

Имя
name string

Базовое имя файла для новых PDF-файлов

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Создает фоновое задание обработки.

Возвращаемое значение

Имя Путь Тип Описание
URL-адреса
urls array of string

URL-адреса

URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Состояние
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Сведения о электронной почте

Получение сведений электронной почты, таких как отправитель или получатель, тема, текст и т. д. Подробные рекомендации см. в https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

От
body.from string
Имя
body.fromName string
Кому
body.to array of object
Address
body.to.address string
Имя
body.to.Name string

Имя

копия
body.cc array of object
Address
body.cc.address string
Имя
body.cc.Name string

Имя

Скрытая копия
body.bcc array of object
Address
body.bcc.address string
Имя
body.bcc.Name string

Имя

Отправлено в
body.sentAt string
Получено по адресу
body.receivedAt string
Тема
body.subject string
Текст (HTML)
body.bodyHtml string
Текст (текст)
body.bodyText string
Количество вложений
body.attachmentCount integer
Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Сжатие и оптимизация PDF

Оптимизируйте PDF-документ, чтобы уменьшить его размер. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-optimize/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Имя
name string

Имя файла для созданных выходных данных

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Слияние PDF

Слияние PDF-файла из двух или нескольких PDF-файлов в новое. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-merge/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

Разделенный запятыми список ссылок на PDF-файлы. Поддерживает ссылки на внешние сайты из filetoken://.. хранилища файлов PDF.co и ссылок на G Drive, Dropbox и другие службы. Ссылки должны быть доступны без пароля. Для защищенных паролем PDF-файлов сначала используйте модуль безопасности PDF для разблокировки входных pdf-файлов.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Код состояния
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Слияние PDF (дополнительно)

Слияние PDF-файла из двух или нескольких pdf-файлов, doc, xls, изображений, даже zip с документами и изображениями в новый PDF-файл. Поддерживает zip, docx, xls, xlsx, rtf, txt, png, jpg. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

Разделенный запятыми список ссылок на PDF-файлы, документы, электронные таблицы, изображения. Поддерживает ссылки на внешние сайты из filetoken://.. хранилища файлов PDF.co и ссылок на G Drive, Dropbox и другие службы. Ссылки должны быть доступны без пароля. Для защищенных паролем PDF-файлов сначала используйте модуль безопасности PDF для разблокировки входных pdf-файлов.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес выходного документа.

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

Количество страниц в выходном документе.

Ошибка
error boolean

Указывает, выполнена ли операция успешно или нет.

Код состояния
status integer

Код состояния для HTTP-ответа

Имя
name string

Имя выходного документа

Благодарности
credits integer

PDF.co кредиты, используемые для этого запроса

Продолжительность
duration integer

Длительность выполнения запроса

Оставшиеся кредиты
remainingCredits integer

PDF.co счета, оставшиеся кредиты

Создание отсканированного PDF-файла в доступный для поиска текста

Преобразуйте PDF и отсканированные изображения JPG, PNG в текстовый PDF-файл. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Язык OCR
lang string

язык OCR (текст из изображения), используемый для отсканированных документов PDF, PNG и JPG при извлечении текста. Значение по умолчанию — "eng". Другие языки также поддерживаются: deu, spa, chi_sim, jpn и многие другие (полный список поддерживаемых языков OCR находится на ).https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support Вы также можете одновременно использовать два языка: eng+deu или jpn+kor (любое сочетание).

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Пароль
password string

Пароль PDF-файла

Асинхронность
async boolean

Задайте значение Async значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck для проверки состояния процесса и извлечения выходных данных, а также для выполнения других задач, не ожидая завершения этого процесса.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Средство синтаксического анализа документов

Средство синтаксического анализа документов документов может автоматически анализировать PDF, JPG и PNG-документы для извлечения полей, таблиц, значений и штрихкодов из счетов, инструкций, заказов и других документов PDF и сканированных документов. Подробные рекомендации см. в https://developer.pdf.co/api/document-parser/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов. Чтобы отправить файлы с помощью API, ознакомьтесь с разделом "Отправка файлов" в разделе https://developer.pdf.co/api/file-upload/index.html

Идентификатор шаблона
templateId string

Задайте идентификатор используемого шаблона синтаксического анализа документов. Просмотр шаблонов и управление ими https://app.pdf.co/document-parser

Формат выходных данных
outputFormat True string

Значением по умолчанию является JSON. Вы можете переопределить формат выходных данных по умолчанию в CSV или XML, чтобы создать выходные данные CSV или XML соответствующим образом.

Встроенный
inline boolean

Задайте значение true, чтобы возвращать результаты внутри ответа. В противном случае конечная точка вернет ссылку на выходной файл, созданный

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Ознакомьтесь с PDF.co базой https://developer.pdf.co/api/profiles/index.html знаний для примеров профилей.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с параметром "Check" для проверки состояния процесса и извлечения выходных данных, а также для выполнения других задач, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес вывода

Объектов
body.objects array of object

tables

имя
body.objects.name string

имя

objectType
body.objects.objectType string

тип объекта

value
body.objects.value string

value

pageIndex
body.objects.pageIndex integer

pageIndex

прямоугольник
body.objects.rectangle array of float

прямоугольник

Строк
body.objects.rows array of object

Строк

items
body.objects.rows object
Число страниц
pageCount integer
Идентификатор задания
jobId string
Состояние
status integer
Имя
name string
Оставшиеся кредиты
remainingCredits integer
Message
message string

Средство чтения сведений PDF

Получите подробные сведения о PDF-документе, его свойствах и разрешениях безопасности. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-info-reader/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительную конфигурацию для точной настройки и дополнительных параметров, ознакомьтесь с примерами PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html).

Возвращаемое значение

Имя Путь Тип Описание
JobId
jobId string

jobId

URL
url string

URL-адрес

PageCount
info.PageCount integer

PageCount

Author
info.Author string

Author

Название
info.Title string

Название

Producer
info.Producer string

Producer

Тема
info.Subject string

Тема

CreationDate
info.CreationDate string

CreationDate

Bookmarks
info.Bookmarks string

Bookmarks

Ключевые слова
info.Keywords string

Ключевые слова

Создатель
info.Creator string

Создатель

С шифрованием
info.Encrypted boolean

С шифрованием

PasswordProtected
info.PasswordProtected boolean

PasswordProtected

Является пустым
info.PageRectangle.Location.IsEmpty boolean

Является пустым

info.PageRectangle.Location.X float

X

info.PageRectangle.Location.Y float

У

Size
info.PageRectangle.Size string

Size

info.PageRectangle.X float

X

info.PageRectangle.Y float

У

info.PageRectangle.Width float

Ширина

info.PageRectangle.Height float

Высота

info.PageRectangle.Left float

Лево

info.PageRectangle.Top float

Верх

info.PageRectangle.Right float

Правильно

info.PageRectangle.Bottom float

По нижнему краю

Является пустым
info.PageRectangle.IsEmpty boolean

Является пустым

ИзменениеDate
info.ModificationDate string

ИзменениеDate

Количество Вложений
info.AttachmentCount integer

Количество Вложений

EncryptionAlgorithm
info.EncryptionAlgorithm string

EncryptionAlgorithm

PermissionPrinting
info.PermissionPrinting boolean

PermissionPrinting

PermissionModifyDocument
info.PermissionModifyDocument boolean

PermissionModifyDocument

PermissionContentExtraction
info.PermissionContentExtraction boolean

PermissionContentExtraction

PermissionModifyAnnotations
info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations

PermissionFillForms
info.PermissionFillForms boolean

PermissionFillForms

PermissionAccessibility
info.PermissionAccessibility boolean

PermissionAccessibility

PermissionAssemble
info.PermissionAssemble boolean

PermissionAssemble

PermissionHighQualityPrint
info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Средство чтения сведений о формах PDF

Получение сведений о заполняемых полях в PDF-файле формы. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-forms-info-reader/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительную конфигурацию для точной настройки и дополнительных параметров, ознакомьтесь с примерами PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html).

Возвращаемое значение

Имя Путь Тип Описание
JobId
jobId string

jobId

URL
url string

URL-адрес

PageCount
info.PageCount integer

PageCount

Author
info.Author string

Author

Название
info.Title string

Название

Producer
info.Producer string

Producer

Тема
info.Subject string

Тема

CreationDate
info.CreationDate string

CreationDate

Bookmarks
info.Bookmarks string

Bookmarks

Ключевые слова
info.Keywords string

Ключевые слова

Создатель
info.Creator string

Создатель

С шифрованием
info.Encrypted boolean

С шифрованием

PasswordProtected
info.PasswordProtected boolean

PasswordProtected

Является пустым
info.PageRectangle.Location.IsEmpty boolean

Является пустым

X
info.PageRectangle.Location.X float

X

У
info.PageRectangle.Location.Y float

У

Size
info.PageRectangle.Size string

Size

X
info.PageRectangle.X float

X

У
info.PageRectangle.Y float

У

Ширина
info.PageRectangle.Width float

Ширина

info.PageRectangle.Height float

Высота

info.PageRectangle.Left float

Лево

Верх
info.PageRectangle.Top float

Верх

Правильно
info.PageRectangle.Right float

Правильно

info.PageRectangle.Bottom float

По нижнему краю

Является пустым
info.PageRectangle.IsEmpty boolean

Является пустым

ИзменениеDate
info.ModificationDate string

ИзменениеDate

Количество вложений
info.AttachmentCount integer

Количество Вложений

EncryptionAlgorithm
info.EncryptionAlgorithm string

EncryptionAlgorithm

PermissionPrinting
info.PermissionPrinting boolean

PermissionPrinting

PermissionModifyDocument
info.PermissionModifyDocument boolean

PermissionModifyDocument

PermissionContentExtraction
info.PermissionContentExtraction boolean

PermissionContentExtraction

PermissionModifyAnnotations
info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations

PermissionFillForms
info.PermissionFillForms boolean

PermissionFillForms

PermissionAccessibility
info.PermissionAccessibility boolean

PermissionAccessibility

PermissionAssemble
info.PermissionAssemble boolean

PermissionAssemble

PermissionHighQualityPrint
info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint

CustomProperties
info.CustomProperties array of object

CustomProperties

Key
info.CustomProperties.Key string

Key

Ценность
info.CustomProperties.Value string

Ценность

Fields
info.FieldsInfo.Fields array of object

Fields

PageIndex
info.FieldsInfo.Fields.PageIndex integer

PageIndex

Тип
info.FieldsInfo.Fields.Type string

Тип

FieldName
info.FieldsInfo.Fields.FieldName string

FieldName

AltFieldName
info.FieldsInfo.Fields.AltFieldName string

AltFieldName

Ценность
info.FieldsInfo.Fields.Value string

Ценность

Лево
info.FieldsInfo.Fields.Left float

Лево

Верх
info.FieldsInfo.Fields.Top float

Верх

Ширина
info.FieldsInfo.Fields.Width float

Ширина

Высота
info.FieldsInfo.Fields.Height float

Высота

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Средство чтения штрихкодов

Чтение штрихкодов из изображений и PDF. Может читать все популярные типы штрихкодов из QR-кода и кода 128, EAN в Datamatrix, PDF417, GS1 и многих других штрихкодов. Подробные рекомендации см. в https://developer.pdf.co/api/barcode-reader/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Типы
types True string

Задайте тип штрихкода, QRCode по умолчанию. Можно также объединить типы по запятой, например QRCode, Code128,Code39,Interleaved2of5,EAN13. Все поддерживаемые типы штрихкодов: AustralianPostCode, Aztec, BorderedTable, Circle, Circle, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, DPMDataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN14, GTIN18, HorizontalLine, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, Овал, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, Rectangle, RoyalMail, RoyalMailKIX, Segment, Trioptic, ПодчеркнутоField, UPCA, UPCE, UPU, VerticalLine.

Страницы
pages string

Comma-Separated список индексов страниц (или диапазонов) для обработки. ВАЖНО: первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте следующий диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до конца документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7— означает первую страницу, а затем 3-ю страницу на 6-ю страницу, а затем диапазон от 8-й (индекс = 7) до конца документа.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
JobId
jobId string

jobId

URL
url string

URL-адрес

штрихкоды
barcodes array of object

штрихкоды

Ценность
barcodes.Value string

Ценность

Тип
barcodes.Type integer

Тип

Rect
barcodes.Rect string

Rect

Страница
barcodes.Page integer

Страница

Файл
barcodes.File string

Файл

Достоверность
barcodes.Confidence float

Достоверность

Метаданные
barcodes.Metadata string

Метаданные

ТипИмя
barcodes.TypeName string

ТипИмя

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Страницы удаления PDF

Удаление страниц в ФОРМАТЕ PDF. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-delete-pages/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. Первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Имя
name string

Имя файла для созданных выходных данных

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Таблица поиска PDF

Анализ документов на основе искусственного интеллекта может сканировать документ для таблиц и возвращать массив таблиц на страницах с координатами и сведениями о столбцах, обнаруженных в этих таблицах. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. ВАЖНО: первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа). Для ВСЕХ страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7- означает первую страницу, а затем 3-ю страницу до 6-й страницы, а затем диапазон от 8-го (индекс = 7) до конца документа.

Встроенный
inline boolean
Пароль
password string

Пароль PDF-файла

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой /job/check, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор задания
jobId string

jobId

URL
url string

URL-адрес

tables
body.tables array of object

tables

PageIndex
body.tables.PageIndex integer

PageIndex

body.tables.X float

X

У
body.tables.Y float

У

Ширина
body.tables.Width float

Ширина

body.tables.Height float

Высота

Колонны
body.tables.Columns array of float

Колонны

Прямоугольник
body.tables.rect string

rect

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

Благодарности

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Текст поиска PDF

Поиск текста в ФОРМАТЕ PDF и получение координат. Поддерживает регулярные выражения. Подробные рекомендации см. в https://developer.pdf.co/api/pdf-find/index.html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Строка поиска
searchString True string

Текст для поиска может поддерживать регулярные выражения, если для параметра Regex Search задано значение true.

Поиск регулярных выражений
regexSearch boolean
Страницы
pages string

Разделенный запятыми список индексов страниц (или диапазонов) для обработки. ВАЖНО: первая страница начинается с 0 (ноль). Чтобы задать диапазон, используйте дефис, например: 0,2-5,7-. Чтобы задать диапазон от индекса до последней страницы, используйте такой диапазон: 2- (от страницы #3, так как индекс начинается с нуля и до документа) для всех страниц просто оставьте этот параметр пустым. Пример: 0,2-5,7— означает первую страницу, а затем 3-ю страницу на 6-ю страницу, а затем диапазон от 8-й (индекс = 7) до конца документа, входные данные должны быть в строковом формате.

Встроенный
inline boolean
Режим сопоставления слов
wordMatchingMode string

Значения могут быть либо SmartMatch, "ExactMatch", либо "Нет".

Пароль
password string

Пароль PDF-файла

Асинхронность
async boolean

Установите асинхронное значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с модулем JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Используйте этот параметр, чтобы задать дополнительные конфигурации для тонкой настройки и дополнительных параметров. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
body
body array of object

body

Текст
body.text string

текст

Лево
body.left float

левый

Верх
body.top float

top

Ширина
body.width float

Ширина

Высота
body.height float

height

Индекс страницы
body.pageIndex integer

pageIndex

URL
url string

URL-адрес

Идентификатор задания
jobId string
Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Удаление PDF-файла

Удалите пароль и безопасность из существующих PDF-файлов. Подробные рекомендации см. в https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Пароль
password True string

Пароль владельца или пользователя для открытия файлов и удаления функций безопасности.

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string
Идентификатор задания
jobId string

jobId

Число страниц
pageCount integer

pageCount

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

Оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Электронная таблица в CSV

Преобразуйте XLS/XLSX в csv-файл разделенных запятыми значений. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Символ кавычки
quotationSymbol string

Установка символа кавычки CSV

Символ разделителя
separatorSymbol string

Установка символа разделителя CSV

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Электронная таблица в HTML

Преобразуйте XLS/XLSX в HTML-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Электронная таблица в JSON

Преобразуйте XLS/XLSX в JSON-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Электронная таблица в TXT

Преобразуйте XLS/XLSX или CSV-файл в текстовый файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration

Электронная таблица в XML

Преобразуйте XLS/XLSX или CSV-файл в XML-файл. Подробные рекомендации см. в https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml документации по API.

Параметры

Имя Ключ Обязательно Тип Описание
URL
url True string

URL-адрес исходного файла. Поддерживает ссылки из Google Drive, Dropbox и PDF.co встроенное хранилище файлов.

Индекс листа
worksheetIndex string

Задайте индекс листа (по умолчанию — 0).

Имя
name string

Имя файла для созданных выходных данных.

Expiration
expiration integer

Задайте время окончания срока действия выходной ссылки в минутах (по умолчанию — 60 минут или 1 час), после указанной длительности все созданные выходные файлы будут автоматически удалены из PDF.co временных файлов хранилища. Максимальная длительность срока действия ссылки зависит от текущего плана подписки.

Асинхронность
async boolean

Установите значение true для длительных процессов, выполняемых в фоновом режиме, API возвращает идентификатор задания, который можно использовать с конечной точкой JobCheck, чтобы проверить состояние процесса и получить выходные данные, пока вы можете продолжить работу с другими задачами, не ожидая завершения этого процесса.

Profiles
profiles string

Дополнительные и дополнительные параметры можно задать с помощью этого параметра, что позволяет задать настраиваемую конфигурацию. Изучите PDF.co базы знаний (https://developer.pdf.co/api/profiles/index.html) для примеров профилей.

Возвращаемое значение

Имя Путь Тип Описание
URL
url string

URL-адрес

Идентификатор задания
jobId string

jobId

Ошибка
error boolean

ошибка

Состояние
status integer

статус

Имя
name string

имя

Благодарности
credits integer

credits

оставшиеся кредиты
remainingCredits integer

оставшиеся кредиты

Продолжительность
duration integer

duration