Уменьшить фото API

Уменьшить фото API, ФотоМини подключает задачу к вашему приложению: вы отправляете файл, проверяете статус задачи и скачиваете результат. Эндпоинты выполняются на сервере без участия браузера.

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

  1. Создайте ключ в разделе API для разработчиков вашего аккаунта; ключ в открытом виде отображается только в момент создания.
  2. Отправьте запрос на https://api.pixepi.com с заголовком Authorization: Bearer <key>.
  3. Опрашивайте задачу из ответа с помощью GET https://api.pixepi.com/api/v1/jobs/{id}; когда статус изменится на done, скачайте результат по адресу из download_url.

Пример запроса

curl -X POST "https://api.pixepi.com/api/v1/apps/gorsel-kucult/run" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -F "file=@файл.jpg" \
  -F "options[quality]=82" \
  -F "options[format]=same"

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/jobs/42"

Эндпоинты этого инструмента

МетодПутьНазначение
POST/runЗапускает инструмент, создает задачу и возвращает результат.

Параметры

Параметры передаются как options[<field>]; для пустого поля используется значение по умолчанию.

ПолеЗначенияПо умолчанию
options[quality]
Качество
40–9582
options[max_side]
Предел длинной стороны (необязательно)
0–6000пусто
options[format]
Формат вывода
same · jpeg · webp · pngsame
options[auto_rotate]
Автоматически исправлять ориентацию снимков с телефона
включено · отключеновключено

Общие эндпоинты

МетодПутьНазначение
GET/api/v1/appsКаталог API
GET/api/v1/apps/gorsel-kucultКонтракт инструмента
GET/api/v1/jobs/{id}Статус задачи
GET/api/v1/jobs/{id}/downloadСкачать результат задачи
GET/api/v1/usageСводка использования
GET/api/v1/openapi.jsonДокумент OpenAPI 3.1

Ограничения

  • Не более 100 MB на файл.
  • Пакетная обработка: отправьте поле file несколько раз.
  • Информация о квотах и тарифе привязана к вашему аккаунту; проверьте текущее состояние с помощью GET /api/v1/usage.

Коды ошибок

КодЗначение
unauthorizedКлюч API отсутствует или недействителен.
forbiddenЭта операция запрещена с данным ключом.
not_foundИнструмент, задача или запись не найдены (404 также при доступе из другого аккаунта).
invalid_inputОшибка проверки входных данных (пропущено или повреждено поле, неверная дата и т. д.).
invalid_requestНекорректный запрос.
too_largeРазмер файла или тела запроса превышает лимит.
unsupported_mediaТип файла не поддерживается.
not_supportedЭтот инструмент не может работать на этой конечной точке (stateful app).
not_readyЗадача еще не завершена.
expiredСрок действия файла истек.
no_outputНет готовых файлов для скачивания.
invalid_pathНедопустимый путь к файлу.
quota_exceededПревышена квота или лимит запросов.
rate_limitedСлишком много запросов за короткое время; подождите немного и повторите попытку.
csrfОшибка проверки формы браузера (внешний API использует ключи).
conflictОперация конфликтует с текущим состоянием.
unavailableИнструмент временно недоступен.
internal_errorНепредвиденная ошибка сервера.

Документы

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

Где получить API-ключ?

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

Как отправить запрос?

Эндпоинты доступны по адресу https://api.pixepi.com; каждый запрос должен содержать заголовок "Authorization: Bearer <key>".

Какие файлы принимает API ФотоМини?

Поддерживаемые форматы: JPG · JPEG · PNG · WEBP. Лимит — 100 MB на файл; параметры совпадают с указанными на странице инструмента.

Как обрабатывать ответ с ошибкой?

Тело ошибки содержит поля {ok:false, error, code, request_id}; возможные значения кода приведены в таблице кодов ошибок.