Использовать POST /api/uploads, Затем загрузите с тюками в возвращенный upload_url. Требуется только для imagick, esrgan, video_convert, audio_convert, archive, pandoc.
AMPX API
Автоматизируйте конвертацию файлов, задачи инструментов и обработку результатов через удобный REST API.
API-доступ — платное дополнение
Выберите Starter, Basic или Pro, а затем добавьте API-ключ к той же ежемесячной подписке Stripe. API использует тот же кредитный пул и лимит ставок, что и веб-инструменты.
Конверсия API Workflow
Загрузка URL начинается на этапе 2. Преобразователи файлов сначала резервируют и загружают файлы с помощью tus.
Отправить POST /api/convert с услугой type либо исходный URL, либо выделенные данные загрузки.
Звони. GET /api/status?token=... Пока государство не finished, failed или cancelled. Токен привязан к ключу API, который его создал.
Используйте возвращенный download_url или GET /d/{token}. Единичные и текстовые утилиты возвращаются синхронно и пропускают опрос статуса.
Starter
Basic
Pro
Доступные услуги и кредитные цены
Кредиты взимаются только тогда, когда операция успешна. Неудачные или отмененные работы освобождают их резервацию. Файловые операции добавляют показанный размер заряда на запущенный 10 MB конечного вывода.
| Сервис | Тип | Базовые кредиты | Заряд окончательного размера | статус |
|---|---|---|---|---|
| Видео скачать Загрузите видео из YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo или другого поддерживаемого источника. |
работа | 12 | +1 / начинать 10 MB | Доступный |
| Скачать аудио Извлеките аудио из поддерживаемого медиа URL. |
работа | 8 | +1 / начинать 10 MB | Доступный |
| Преобразователь изображений и объемный редактор Преобразовать, изменить размер, обрезать, вращать и редактировать одно или несколько загруженных изображений. |
работа | 5 | +1 / начинать 10 MB | Доступный |
| Аудио конвертер Преобразуйте загруженный аудиофайл. |
работа | 5 | +1 / начинать 10 MB | Доступный |
| Конвертер видео Преобразуйте загруженное видео с помощью предустановленного списка FFmpeg для YouTube, Instagram Reels или TikTok Shorts. |
работа | 12 | +1 / начинать 10 MB | временно отключенный |
| Архивный конвертер Создание или преобразование загруженного архива. |
работа | 5 | +1 / начинать 10 MB | Доступный |
| Преобразователь документов Преобразуйте поддерживаемый загруженный документ в Pandoc. |
работа | 5 | +1 / начинать 10 MB | временно отключенный |
| ИИ Image Upscaler Увеличьте загруженное изображение с помощью поддерживаемой модели ESRGAN. |
работа | 25 | +1 / начинать 10 MB | Доступный |
| Проверка Proxy Проверьте пакет HTTP, HTTPS или SOCKS proxies. |
работа | 1 / 5 предметы | Никто | Доступный |
| Единичный преобразователь синхронный Работа конвертера. |
полезность | 1 | Никто | Доступный |
| Текстовые коммуникации синхронный Работа текстовых утилит. |
полезность | 1 | Никто | Доступный |
аутентификация
Отправьте ключ в качестве маркера Bearer. Он проявляется только один раз при создании или повороте.
Пределы и зарядка
Ключ использует те же кредиты и операции / минутный лимит, что и веб-счет. Успешная утилита взимается немедленно; асинхронная работа резервирует кредиты и погашает их после завершения.
Машиночитаемые документы
Получите аутентифицированный документ OpenAPI 3.1 с тем же заголовком Bearer.
Справка о службе
Все операции API и необходимые поля перечислены ниже. Добавить Idempotency-Key При повторном запросе.
POST /api/uploads — Распределить загрузку файлов
Для imagick, esrgan, video_convert, audio_convert, archive, pandoc, Сначала выделите одно или несколько имен файлов. Загрузите каждый файл с tus в возвращенный upload_url, сохранение возвращенных метаданных файла. Возвращается обратно или files[].relative_path Работник Пандока, для /api/convert.
{
"ok": true,
"data": {
"token": "UPLOAD_TOKEN",
"worker": "worker1",
"files": [{"name": "input.png", "relative_path": "UPLOAD_TOKEN/input.png"}],
"upload_url": "https://worker.example/api/upload/tus",
"protocol": "tus"
}
}
Скачать Tus 1.0: Создайте ресурс загрузки в upload_url. Оба token и filename в Upload-Metadata Базовые 64-кодированные значения. Ответ возвращает URL-адрес возобновляемого ресурса Location Голова.
Загрузите байты в это Location. Если передача возобновляется, получите текущее смещение с помощью tus. HEAD Запросить и отправить это значение как Upload-Offset.
POST /api/convert — Видео скачать
Загрузите видео из YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo или другого поддерживаемого источника. Базовая цена: 12 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
url | string|required |
format | string|optional |
quality | string|optional |
fps | integer|optional |
playlist | boolean|optional |
source_service | string|optional |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Скачать аудио
Извлеките аудио из поддерживаемого медиа URL. Базовая цена: 8 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
url | string|required |
format | mp3|m4a|flac|aac |
quality | string|optional |
playlist | boolean|optional |
source_service | string|optional |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Преобразователь изображений и объемный редактор
Преобразовать, изменить размер, обрезать, вращать и редактировать одно или несколько загруженных изображений. Базовая цена: 5 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
operations | object|optional (auto_orient, trim, strip, quality, rotate, flip, flop, invert, resize, fit or pad) |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Аудио конвертер
Преобразуйте загруженный аудиофайл. Базовая цена: 5 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Конвертер видео
Преобразуйте загруженное видео с помощью предустановленного списка FFmpeg для YouTube, Instagram Reels или TikTok Shorts. Базовая цена: 12 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | mp4|webm|required |
preset | youtube|instagram_reels|tiktok_shorts|square_mp4|classic_4_3|widescreen_16_9|generic_mp4|generic_webm|optional |
aspect_ratio | preset|source|1:1|4:3|16:9|9:16|optional |
fit_mode | pad|crop|stretch|optional |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Архивный конвертер
Создание или преобразование загруженного архива. Базовая цена: 5 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
max_output_bytes | integer|optional |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Преобразователь документов
Преобразуйте поддерживаемый загруженный документ в Pandoc. Базовая цена: 5 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
input_path | string|required (files[].relative_path returned by POST /api/uploads) |
from_format | string|required |
to_format | string|required |
worker | string|required (from POST /api/uploads) |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — ИИ Image Upscaler
Увеличьте загруженное изображение с помощью поддерживаемой модели ESRGAN. Базовая цена: 25 Кредит(ы), плюс кредит (кредиты) 1 на стартовый 10 МБ конечного продукта.
| поле | Тип/требование |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
model | string|optional |
scale | integer|optional (2-4) |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/convert — Проверка Proxy
Проверьте пакет HTTP, HTTPS или SOCKS proxies. Базовая цена: 1 Кредит(ы).
| поле | Тип/требование |
|---|---|
type | string|required |
proxies | array|required |
default_protocol | string|optional |
timeout_sec | integer|optional |
connect_timeout_sec | integer|optional |
test_url | url|optional |
Успешное представление возвращается token, state, status_url, download_url и резервную сумму кредита.
POST /api/utilities/unit-convert — Единичный преобразователь
синхронный Работа конвертера. Базовая цена: 1 Кредит(ы).
| поле | Тип/требование |
|---|---|
category | string|required |
from | string|required |
to | string|required |
value | number|required |
precision | integer|optional |
Эта утилита синхронно реагирует на свой результат и заряженное использование.
POST /api/utilities/text — Текстовые коммуникации
синхронный Работа текстовых утилит. Базовая цена: 1 Кредит(ы).
| поле | Тип/требование |
|---|---|
text | string|required |
operations | array|optional |
Эта утилита синхронно реагирует на свой результат и заряженное использование.
Статус и пример загрузки
Опросить только status_url Возвращался на работу. Когда его состояние finished и ready Это правда, следуйте download_url; Неудачные и отмененные рабочие места освобождают свои зарезервированные кредиты.
{
"ok": true,
"data": {
"token": "JOB_TOKEN",
"state": "finished",
"ready": true,
"download_url": "https://ampx.cc/d/JOB_TOKEN"
}
}
Договор об ошибках
Ошибки используют {"ok":false,"error":{"code":"…","message":"…"}}. Доступ требует эффективного платного плана плюс отдельное дополнение API или грант администратора с включенным доступом API.
| Код | HTTP |
|---|---|
bearer_token_missing | 401 |
invalid_api_key | 403 |
paid_plan_required | 403 |
api_addon_required | 403 |
billing_not_active | 403 |
rate_limit_exceeded | 429 |
upload_too_large | 413 |
credits_exhausted | 429 |
idempotency_conflict | 409 |
invalid_request | 422 |
scope_not_allowed | 403 |
service_disabled | 503 |