Utilização POST /api/uploads, em seguida, enviar com tus para o retornado upload_url. Só é necessário para imagick, esrgan, video_convert, audio_convert, archive, pandoc.
API da AMPX
Automatize conversões de arquivos, tarefas de ferramentas e resultados com uma API REST simples.
O acesso à API é um complemento pago
Escolha Starter, Basic ou Pro, em seguida, adicione a chave API para essa mesma assinatura mensal Stripe. A API usa o mesmo pool de crédito de conta e limite de taxa que as ferramentas web.
Fluxo de trabalho da API de conversão
Os downloads de URL começam no passo 2. Os conversores de arquivos primeiro reserva e upload de arquivos com tus.
Enviar POST /api/convert com um serviço type e uma URL de origem ou os dados de envio alocados.
Chamada GET /api/status?token=... até que o estado esteja finished, failed ou cancelled. O token é escopo para a chave API que o criou.
Usar o retornado download_url ou GET /d/{token}. Utilitários de unidade e texto retornam síncrona e ignoram pesquisas de status.
Starter
Basic
Pro
Serviços disponíveis e preços de crédito
Os créditos só são cobrados quando uma operação é bem sucedida. Falha ou cancelamento de trabalhos liberam sua reserva. Operações de arquivo adicionam a carga de tamanho mostrada por 10 MB de saída final.
| Serviço | Tipo | Créditos de base | Carga de tamanho final | Estado |
|---|---|---|---|---|
| Transferência de vídeo Baixar vídeo de YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo ou outra fonte suportada. |
trabalho | 12 | +1 / iniciado 10 MB | Disponível |
| Transferência de áudio Extrair áudio de uma URL de mídia suportada. |
trabalho | 8 | +1 / iniciado 10 MB | Disponível |
| Conversor de imagens e editor de volume Converter, redimensionar, cortar, girar e editar uma ou mais imagens enviadas. |
trabalho | 5 | +1 / iniciado 10 MB | Disponível |
| conversor de áudio Converter um arquivo de áudio carregado. |
trabalho | 5 | +1 / iniciado 10 MB | Disponível |
| Conversor de vídeo Converter um vídeo carregado com uma lista autorizada FFmpeg predefinido para YouTube, Instagram Reels ou TikTok Shorts. |
trabalho | 12 | +1 / iniciado 10 MB | Desactivado temporariamente |
| Conversor de arquivos Criar ou converter um arquivo carregado. |
trabalho | 5 | +1 / iniciado 10 MB | Disponível |
| Conversor de documentos Converta um documento carregado com o Pandoc. |
trabalho | 5 | +1 / iniciado 10 MB | Desactivado temporariamente |
| Escalador de imagem de IA Aumentar uma imagem enviada com um modelo ESRGAN suportado. |
trabalho | 25 | +1 / iniciado 10 MB | Disponível |
| Verificador Proxy Verifique um lote de HTTP, HTTPS ou SOCKS proxies. |
trabalho | 1 / 5 itens | Nenhum | Disponível |
| Conversor unitário Sincronizado Operação de conversor de unidade. |
utilitário | 1 | Nenhum | Disponível |
| Utilitários de texto Sincronizado Operação de utilitários de texto. |
utilitário | 1 | Nenhum | Disponível |
autenticação
Envie a chave como um símbolo de portador. É mostrado apenas uma vez quando criado ou rodado.
Limites e tarifação
A chave utiliza os mesmos créditos e operações/limite de minutos que a conta web. Um utilitário bem sucedido é cobrado imediatamente; um crédito de reserva de trabalho assíncrono e os liquida após a conclusão.
Documentos legíveis por máquina
Obter o documento OpenAPI 3.1 autenticado com o mesmo cabeçalho do portador.
Referência do serviço
Todas as operações da API e campos obrigatórios estão listados abaixo. Adicionar Idempotency-Key ao tentar novamente um pedido.
POST /api/uploads — alocar uploads de arquivos
Para imagick, esrgan, video_convert, audio_convert, archive, pandoc, primeiro alocar um ou mais nomes de arquivos. Enviar cada arquivo com o tus para o retornado upload_url, preservando os metadados de arquivo retornados. Em seguida, enviar o token devolvido, ou files[].relative_path e trabalhador para o Pandoc, /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"
}
}
Enviar com tus 1.0: criar o recurso de envio em upload_url. Ambos token e filename em Upload-Metadata são valores codificados por base64. A resposta devolve o URL do recurso reutilizável na sua Location Cabeçalho.
Enviar bytes para isso Location. Se uma transferência retomar, obtenha o deslocamento atual com um tus HEAD solicitar e enviar esse valor como Upload-Offset.
POST /api/convert — Transferência de vídeo
Baixar vídeo de YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo ou outra fonte suportada. Preço base: Crédito(s) 12, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
url | string|required |
format | string|optional |
quality | string|optional |
fps | integer|optional |
playlist | boolean|optional |
source_service | string|optional |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Transferência de áudio
Extrair áudio de uma URL de mídia suportada. Preço base: Crédito(s) 8, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
url | string|required |
format | mp3|m4a|flac|aac |
quality | string|optional |
playlist | boolean|optional |
source_service | string|optional |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Conversor de imagens e editor de volume
Converter, redimensionar, cortar, girar e editar uma ou mais imagens enviadas. Preço base: Crédito(s) 5, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
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) |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — conversor de áudio
Converter um arquivo de áudio carregado. Preço base: Crédito(s) 5, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Conversor de vídeo
Converter um vídeo carregado com uma lista autorizada FFmpeg predefinido para YouTube, Instagram Reels ou TikTok Shorts. Preço base: Crédito(s) 12, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
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 |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Conversor de arquivos
Criar ou converter um arquivo carregado. Preço base: Crédito(s) 5, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
max_output_bytes | integer|optional |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Conversor de documentos
Converta um documento carregado com o Pandoc. Preço base: Crédito(s) 5, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
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) |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Escalador de imagem de IA
Aumentar uma imagem enviada com um modelo ESRGAN suportado. Preço base: Crédito(s) 25, mais 1 crédito(s) por 10 iniciado MB de saída final.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
model | string|optional |
scale | integer|optional (2-4) |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/convert — Verificador Proxy
Verifique um lote de HTTP, HTTPS ou SOCKS proxies. Preço base: Crédito(s) 1.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
proxies | array|required |
default_protocol | string|optional |
timeout_sec | integer|optional |
connect_timeout_sec | integer|optional |
test_url | url|optional |
Uma apresentação bem- sucedida retorna token, state, status_url, download_url e o montante de crédito reservado.
POST /api/utilities/unit-convert — Conversor unitário
Sincronizado Operação de conversor de unidade. Preço base: Crédito(s) 1.
| Campo | Tipo / requisito |
|---|---|
category | string|required |
from | string|required |
to | string|required |
value | number|required |
precision | integer|optional |
Este utilitário responde síncrono com seu resultado e uso cobrado.
POST /api/utilities/text — Utilitários de texto
Sincronizado Operação de utilitários de texto. Preço base: Crédito(s) 1.
| Campo | Tipo / requisito |
|---|---|
text | string|required |
operations | array|optional |
Este utilitário responde síncrono com seu resultado e uso cobrado.
Status e exemplo de download
Apenas o status_url Voltou para o seu emprego. Quando o seu estado é finished e ready é verdade, siga download_url; falhas e cancelamento de trabalhos liberam seus créditos reservados.
{
"ok": true,
"data": {
"token": "JOB_TOKEN",
"state": "finished",
"ready": true,
"download_url": "https://ampx.cc/d/JOB_TOKEN"
}
}
Contrato de erro
Erros de uso {"ok":false,"error":{"code":"…","message":"…"}}. O acesso requer um plano pago efetivo e o complemento de API separado, ou uma concessão de administrador com acesso de API habilitado.
| Código | 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 |