Uso POST /api/uploads, poi caricare con tus al ritorno upload_url. Richiesto solo per imagick, esrgan, video_convert, audio_convert, archive, pandoc.
API AMPX
Automatizza conversioni di file, attività degli strumenti e gestione dei risultati con una chiara API REST.
L'accesso API è un add-on a pagamento
Scegliere Starter, Basic o Pro, quindi aggiungere la chiave API a quello stesso abbonamento mensile Stripe. L'API utilizza lo stesso pool di credito e il limite di tasso degli strumenti web.
Conversione flusso di lavoro API
I download dell'URL iniziano al passo 2. I convertitori di file prima riservano e caricano i file con tus.
Invia POST /api/convert con un servizio type e sia un URL sorgente o i dati di caricamento assegnati.
Chiamata GET /api/status?token=... fino a quando lo stato è finished, failed o cancelled. Il token è indirizzato alla chiave API che lo ha creato.
Utilizzare il restituito download_url o GET /d/{token}. Unità e utilità di testo ritornano sincronizzati e saltano lo stato polling.
Starter
Basic
Pro
Servizi disponibili e prezzi di credito
I crediti sono addebitati solo quando un'operazione riesce. I lavori non registrati o annullati rilasciano la loro prenotazione. Le operazioni di file aggiungono la carica di dimensione mostrata per 10 MB di uscita finale.
| Servizio | Tipo | Crediti base | Carica a grandezza finale | Stato |
|---|---|---|---|---|
| Scarica il video Scaricare video da YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo o un'altra fonte supportata. |
lavoro | 12 | +1 / iniziato 10 MB | Disponibile |
| Scarica audio Estrarre l'audio da un URL supportato. |
lavoro | 8 | +1 / iniziato 10 MB | Disponibile |
| Convertitore di immagini e editor di massa Convertire, ridimensionare, ritagliare, ruotare e modificare una o più immagini caricate. |
lavoro | 5 | +1 / iniziato 10 MB | Disponibile |
| Convertitore audio Convertire un file audio caricato. |
lavoro | 5 | +1 / iniziato 10 MB | Disponibile |
| Convertitore di video Converti un video caricato con una preimpostazione FFmpeg per YouTube, Instagram Reels o TikTok Shorts. |
lavoro | 12 | +1 / iniziato 10 MB | Disabilitazione temporanea |
| Convertitore di archivio Creare o convertire un archivio caricato. |
lavoro | 5 | +1 / iniziato 10 MB | Disponibile |
| Convertitore di documenti Convertire un documento caricato supportato con Pandoc. |
lavoro | 5 | +1 / iniziato 10 MB | Disabilitazione temporanea |
| AI immagine upscaler Scalare un'immagine caricata con un modello ESRGAN supportato. |
lavoro | 25 | +1 / iniziato 10 MB | Disponibile |
| Checker Proxy Controllare un lotto di HTTP, HTTPS o SOCKS proxies. |
lavoro | 1 / 5 Articolo | Nessuno | Disponibile |
| Convertitore di unità Traduzione: Operazione del convertitore di unità. |
utilità | 1 | Nessuno | Disponibile |
| Utilità del testo Traduzione: Funzionamento di utilità di testo. |
utilità | 1 | Nessuno | Disponibile |
Autenticazione
Invia la chiave come un token Bearer. Viene mostrato solo una volta creato o ruotato.
Limiti e ricarica
La chiave utilizza gli stessi crediti e operazioni/minuto del conto web. Un'utilità di successo viene addebitata immediatamente; un lavoro asincrono riserva crediti e li regola dopo il completamento.
Documenti leggibili in macchina
Prestare il documento autenticato OpenAPI 3.1 con lo stesso intestazione Bearer.
Riferimento del servizio
Tutte le operazioni API e i campi richiesti sono elencati di seguito. Aggiungi Idempotency-Key quando riprovare una richiesta.
POST /api/uploads — assegnare i file
Per imagick, esrgan, video_convert, audio_convert, archive, pandoc, prima assegnare uno o più nomi di file. Caricare ogni file con tus al reso upload_url, preservare i metadati di file restituiti. Quindi inviare il token restituito, o files[].relative_path e lavoratore per Pandoc, a /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"
}
}
Carica con tus 1.0: creare la risorsa di upload upload_url. Entrambi token e filename in Upload-Metadata sono valori base64 codificati. La risposta restituisce l'URL delle risorse recuperabili nel suo Location Intestazione.
Caricare byte a questo Location. Se un trasferimento riprende, ottenere l'offset corrente con un tus HEAD richiedere e inviare tale valore come Upload-Offset.
POST /api/convert — Scarica il video
Scaricare video da YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo o un'altra fonte supportata. Prezzo base: Credito (i) 12, plus 1 credit(s) per 10 MB di uscita finale.
| 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 |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Scarica audio
Estrarre l'audio da un URL supportato. Prezzo base: Credito (i) 8, plus 1 credit(s) per 10 MB di uscita finale.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
url | string|required |
format | mp3|m4a|flac|aac |
quality | string|optional |
playlist | boolean|optional |
source_service | string|optional |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Convertitore di immagini e editor di massa
Convertire, ridimensionare, ritagliare, ruotare e modificare una o più immagini caricate. Prezzo base: Credito (i) 5, plus 1 credit(s) per 10 MB di uscita finale.
| 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) |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Convertitore audio
Convertire un file audio caricato. Prezzo base: Credito (i) 5, plus 1 credit(s) per 10 MB di uscita finale.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Convertitore di video
Converti un video caricato con una preimpostazione FFmpeg per YouTube, Instagram Reels o TikTok Shorts. Prezzo base: Credito (i) 12, plus 1 credit(s) per 10 MB di uscita finale.
| 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 |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Convertitore di archivio
Creare o convertire un archivio caricato. Prezzo base: Credito (i) 5, plus 1 credit(s) per 10 MB di uscita finale.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
max_output_bytes | integer|optional |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Convertitore di documenti
Convertire un documento caricato supportato con Pandoc. Prezzo base: Credito (i) 5, plus 1 credit(s) per 10 MB di uscita finale.
| 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) |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — AI immagine upscaler
Scalare un'immagine caricata con un modello ESRGAN supportato. Prezzo base: Credito (i) 25, plus 1 credit(s) per 10 MB di uscita finale.
| Campo | Tipo / requisito |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
model | string|optional |
scale | integer|optional (2-4) |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/convert — Checker Proxy
Controllare un lotto di HTTP, HTTPS o SOCKS proxies. Prezzo base: Credito (i) 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 |
Una presentazione di successo ritorna token, state, status_url, download_url e l'importo di credito riservato.
POST /api/utilities/unit-convert — Convertitore di unità
Traduzione: Operazione del convertitore di unità. Prezzo base: Credito (i) 1.
| Campo | Tipo / requisito |
|---|---|
category | string|required |
from | string|required |
to | string|required |
value | number|required |
precision | integer|optional |
Questa utility risponde in modo sincrono con il suo risultato e l'utilizzo caricato.
POST /api/utilities/text — Utilità del testo
Traduzione: Funzionamento di utilità di testo. Prezzo base: Credito (i) 1.
| Campo | Tipo / requisito |
|---|---|
text | string|required |
operations | array|optional |
Questa utility risponde in modo sincrono con il suo risultato e l'utilizzo caricato.
Esempio di stato e download
Poll solo il status_url ritornato per il tuo lavoro. Quando il suo stato è finished e ready è vero, segui download_url; lavori falliti e annullati rilasciano i loro crediti riservati.
{
"ok": true,
"data": {
"token": "JOB_TOKEN",
"state": "finished",
"ready": true,
"download_url": "https://ampx.cc/d/JOB_TOKEN"
}
}
Contratto di errore
Uso degli errori {"ok":false,"error":{"code":"…","message":"…"}}. L'accesso richiede un piano pagato efficace più il componente aggiuntivo API separato, o una sovvenzione amministratore con accesso API abilitato.
| Codice | 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 |