Verwendung POST /api/uploads, Dann laden Sie mit tus auf die zurückgegebene upload_url. Nur für imagick, esrgan, video_convert, audio_convert, archive, pandoc erforderlich.
AMPX API
Automatisiere Dateikonvertierungen, Tool-Aufgaben und die Ergebnisverarbeitung mit einer übersichtlichen REST API.
API Access ist ein kostenpflichtiges Add-on
Wählen Sie Starter, Basic oder Pro und fügen Sie dann den API-Schlüssel zu demselben monatlichen Stripe-Abonnement hinzu. Die API verwendet den gleichen Kontokreditpool und das gleiche Zinslimit wie die Web-Tools.
Conversion API Workflow
URL-Downloads beginnen bei Schritt 2. Dateikonverter reservieren und laden zuerst Dateien mit tus hoch.
Senden POST /api/convert mit einem Dienst type und entweder eine Quell-URL oder die zugewiesenen Upload-Daten.
Anruf GET /api/status?token=... Bis der Staat finished, failed oder cancelled. Das Token ist auf den API-Schlüssel beschränkt, der es erstellt hat.
Verwenden Sie die zurückgegebene download_url oder GET /d/{token}. Unit- und Text-Dienstprogramme kehren synchron zurück und überspringen Statusabfragen.
Starter
Basic
Pro
Verfügbare Dienstleistungen und Kreditpreise
Credits werden nur dann belastet, wenn eine Operation erfolgreich ist. Gescheiterte oder abgesagte Jobs geben ihre Reservierung frei. Dateioperationen fügen die gezeigte Ladungsgröße pro gestartetem 10 MB der endgültigen Ausgabe hinzu.
| Dienst | Typ | Basiskredite | Endkundenentgelt | Status |
|---|---|---|---|---|
| Video Download Laden Sie Videos von YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo oder einer anderen unterstützten Quelle herunter. |
Arbeit | 12 | +1 / Beginn 10 MB | verfügbar |
| Audio Download Extrahieren Sie Audio aus einer unterstützten Medien-URL. |
Arbeit | 8 | +1 / Beginn 10 MB | verfügbar |
| Bildwandler und Masseneditor Konvertieren, ändern, beschneiden, drehen und bearbeiten Sie ein oder mehrere hochgeladene Bilder. |
Arbeit | 5 | +1 / Beginn 10 MB | verfügbar |
| Audiowandler Konvertieren Sie eine hochgeladene Audiodatei. |
Arbeit | 5 | +1 / Beginn 10 MB | verfügbar |
| Videowandler Konvertieren Sie ein hochgeladenes Video mit einer zulässigen FFmpeg-Voreinstellung für YouTube, Instagram Reels oder TikTok Shorts. |
Arbeit | 12 | +1 / Beginn 10 MB | Zeitweilig behindert |
| Archivkonverter Erstellen oder Konvertieren eines hochgeladenen Archivs. |
Arbeit | 5 | +1 / Beginn 10 MB | verfügbar |
| Dokumentenkonverter Konvertieren Sie ein unterstütztes hochgeladenes Dokument mit Pandoc. |
Arbeit | 5 | +1 / Beginn 10 MB | Zeitweilig behindert |
| AI Image Upscaler Skalieren Sie ein hochgeladenes Bild mit einem unterstützten ESRGAN-Modell. |
Arbeit | 25 | +1 / Beginn 10 MB | verfügbar |
| Proxy Checker Überprüfen Sie eine Charge von HTTP, HTTPS oder SOCKS proxies. |
Arbeit | 1 / 5 Positionen | Keine | verfügbar |
| Einheitenkonverter Synchron Einheitenumrichterbetrieb. |
Versorgungsleistungen | 1 | Keine | verfügbar |
| Text Dienstprogramme Synchron Text Utilities Operation. |
Versorgungsleistungen | 1 | Keine | verfügbar |
Authentifizierung
Senden Sie den Schlüssel als Bearer-Token. Es wird nur einmal angezeigt, wenn es erstellt oder gedreht wird.
Grenzwerte und Gebühren
Der Schlüssel verwendet die gleichen Credits und Operationen / Minute Limit wie das Web-Konto. Ein erfolgreiches Versorgungsunternehmen wird sofort berechnet; ein asynchroner Job reserviert Gutschriften und begleicht sie nach Abschluss.
Maschinenlesbare Dokumente
Holen Sie das authentifizierte OpenAPI 3.1-Dokument mit dem gleichen Bearer-Header ab.
Betriebsnummer
Alle API-Operationen und erforderlichen Felder sind unten aufgeführt. Addition Idempotency-Key beim Wiederholen einer Anfrage.
POST /api/uploads — Datei-Uploads zuweisen
für imagick, esrgan, video_convert, audio_convert, archive, pandoc, zuerst einen oder mehrere Dateinamen zuweisen. Laden Sie jede Datei mit tus auf die zurückgegebene upload_url, Bewahrung der zurückgegebenen Metadaten. Geben Sie dann das zurückgegebene Token ein oder files[].relative_path und Arbeiter für Pandoc, an /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"
}
}
Hochladen mit tus 1.0: Erstellen Sie die Upload-Ressource unter upload_url. Beide token und filename in Upload-Metadata sind base64-kodierte Werte. Die Antwort gibt die wiederverwendbare Ressourcen-URL in ihrem Location Header.
Upload von Bytes zu diesem Location. Wenn eine Übertragung fortgesetzt wird, erhalten Sie den aktuellen Offset mit einem Tus HEAD Anfordern und senden Sie diesen Wert als Upload-Offset.
POST /api/convert — Video Download
Laden Sie Videos von YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo oder einer anderen unterstützten Quelle herunter. Grundpreis: 12 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
url | string|required |
format | string|optional |
quality | string|optional |
fps | integer|optional |
playlist | boolean|optional |
source_service | string|optional |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Audio Download
Extrahieren Sie Audio aus einer unterstützten Medien-URL. Grundpreis: 8 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
url | string|required |
format | mp3|m4a|flac|aac |
quality | string|optional |
playlist | boolean|optional |
source_service | string|optional |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Bildwandler und Masseneditor
Konvertieren, ändern, beschneiden, drehen und bearbeiten Sie ein oder mehrere hochgeladene Bilder. Grundpreis: 5 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
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) |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Audiowandler
Konvertieren Sie eine hochgeladene Audiodatei. Grundpreis: 5 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Videowandler
Konvertieren Sie ein hochgeladenes Video mit einer zulässigen FFmpeg-Voreinstellung für YouTube, Instagram Reels oder TikTok Shorts. Grundpreis: 12 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
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 |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Archivkonverter
Erstellen oder Konvertieren eines hochgeladenen Archivs. Grundpreis: 5 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
max_output_bytes | integer|optional |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Dokumentenkonverter
Konvertieren Sie ein unterstütztes hochgeladenes Dokument mit Pandoc. Grundpreis: 5 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
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) |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — AI Image Upscaler
Skalieren Sie ein hochgeladenes Bild mit einem unterstützten ESRGAN-Modell. Grundpreis: 25 Kredit(e), plus 1 Credit(s) pro gestartetem 10 MB Endausgabe.
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
model | string|optional |
scale | integer|optional (2-4) |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/convert — Proxy Checker
Überprüfen Sie eine Charge von HTTP, HTTPS oder SOCKS proxies. Grundpreis: 1 Kredit(e).
| Feld | Typ/Anforderung |
|---|---|
type | string|required |
proxies | array|required |
default_protocol | string|optional |
timeout_sec | integer|optional |
connect_timeout_sec | integer|optional |
test_url | url|optional |
Eine erfolgreiche Einreichung kehrt zurück token, state, status_url, download_url und den reservierten Kreditbetrag.
POST /api/utilities/unit-convert — Einheitenkonverter
Synchron Einheitenumrichterbetrieb. Grundpreis: 1 Kredit(e).
| Feld | Typ/Anforderung |
|---|---|
category | string|required |
from | string|required |
to | string|required |
value | number|required |
precision | integer|optional |
Dieses Dienstprogramm reagiert synchron mit seinem Ergebnis und der geladenen Nutzung.
POST /api/utilities/text — Text Dienstprogramme
Synchron Text Utilities Operation. Grundpreis: 1 Kredit(e).
| Feld | Typ/Anforderung |
|---|---|
text | string|required |
operations | array|optional |
Dieses Dienstprogramm reagiert synchron mit seinem Ergebnis und der geladenen Nutzung.
Status und Download Beispiel
Poll nur die status_url für ihren Job zurückgekehrt. Wenn sein Zustand finished und ready ist wahr, folgen download_url; gescheiterte und annullierte Jobs geben ihre reservierten Kredite frei.
{
"ok": true,
"data": {
"token": "JOB_TOKEN",
"state": "finished",
"ready": true,
"download_url": "https://ampx.cc/d/JOB_TOKEN"
}
}
Fehlervertrag
Fehlerverwendung {"ok":false,"error":{"code":"…","message":"…"}}. Access erfordert einen effektiven kostenpflichtigen Plan plus das separate API-Add-On oder einen Administratorzuschuss mit aktiviertem API-Zugriff.
| Code | 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 |