使用 POST /api/uploads, 然后用tus上传到返回的 upload_url. 仅限imagick, esrgan, video_convert, audio_convert, archive, pandoc.
AMPX API
通过清晰的 REST API 自动执行文件转换、工具任务和结果处理。
API 访问是一个付费附加
选择启动器、 Basic 或 Pro, 然后将 API 密钥添加到同一月度 Stripe 订阅。 API使用与网络工具相同的账户信用池和利率限制.
转换 API 工作流程
URL 下载从步骤开始 2。文件转换器首先保留并上传带有tus的文件。
发送 POST /api/convert 服务 type 或分配的上传数据。
打电话 GET /api/status?token=... 直到国家 finished, failed 或者说 cancelled. 符号被放入创建它的API密钥.
使用返回的内容 download_url 或者说 GET /d/{token}. 单位和文本部门同步返回并跳过状态投票。
Starter
Basic
Pro
现有服务和信贷价格
只有在操作成功时才收取信贷。 失败或取消的工作解除了他们的保留 。 文件操作每次启动时添加显示的大小充电 10 最后输出的 MB 。
| 服务 | 类型 | 基本贷项 | 最后费用 | 状态 |
|---|---|---|---|---|
| 视频下载 下载视频从 YouTube, (中文(简体) ). TikTok莱迪特 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 | 暂时残疾 |
| AI 图像上缩放器 用支持的上传图像上调比例 ESRGAN 型号。 |
任务 | 25 | +1 / 开始 10 MB | 可用 |
| Proxy 检查器 请检查access-date=中的日期值 (帮助) HTTP, HTTPS 或 SOCKS proxies. |
任务 | 1 / 5 项目 | 无 | 可用 |
| 单位转换器 同步 单位转换器操作. |
工具 | 1 | 无 | 可用 |
| 文本公用事业 同步 文本公用事业业务。 |
工具 | 1 | 无 | 可用 |
认证
送出钥匙作为"熊"的代币. 它只在创建或旋转时显示一次 。
限制和收费
密钥使用与网络账户相同的入计量和业务/分钟限制. 一项成功的公用事业立即收费;一项同步的工作储备信贷,完成后结算。
机器可读文件
获取认证的 OpenAPI 3.1 带有同一 Bearer 页眉的文档。
服务参考
所有API业务和需要的字段列出如下. 添加 Idempotency-Key 当重试一个请求时。
POST /api/uploads — 分配文件上传
对于 imagick, esrgan, video_convert, audio_convert, archive, pandoc, 首先分配一个或多个文件名。 将每个文件上传到返回的文件 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. 如果恢复转帐,请用tws抵消电流 HEAD 请求并发送该值为 Upload-Offset.
POST /api/convert — 视频下载
下载视频从 YouTube, (中文(简体) ). TikTok莱迪特 Instagram, Facebook, Twitch, X, Vimeo 或其他支持的来源. 基本价格 : 12 信贷, 加号 1 每开始的信贷 10 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 — AI 图像上缩放器
用支持的上传图像上调比例 ESRGAN 型号。 基本价格 : 25 信贷, 加号 1 每开始的信贷 10 最终输出的 MB.
| 外地 | 类型/要求 |
|---|---|
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 检查器
请检查access-date=中的日期值 (帮助) 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 |