Utilisation POST /api/uploads, puis télécharger avec tus vers le retour upload_url. Requis uniquement pour imagick, esrgan, video_convert, audio_convert, archive, pandoc.
API AMPX
Automatisez les conversions de fichiers, les outils et le traitement des résultats avec une API REST claire.
L'accès à l'API est un complément payant
Choisissez Starter, Basic ou Pro, puis ajoutez la touche API à ce même abonnement mensuel Stripe. L'API utilise le même compte de crédit et limite de taux que les outils Web.
Processus d'API de conversion
Les téléchargements d'URL commencent à l'étape 2. Convertisseurs de fichiers d'abord réserver et télécharger des fichiers avec tus.
Envoyer POST /api/convert avec un service type et soit une URL source ou les données de téléchargement attribuées.
Appeler GET /api/status?token=... jusqu'à ce que l'État soit finished, failed ou cancelled. Le jeton est étendu à la clé API qui l'a créé.
Utiliser le retour download_url ou GET /d/{token}. Utilitaires d'unité et de texte retournent synchrone et sautent le vote d'état.
Starter
Basic
Pro
Services disponibles et prix du crédit
Les crédits ne sont facturés que lorsqu'une opération réussit. La réservation a été annulée ou annulée. Opérations de fichier ajouter la charge de taille affichée par démarré 10 MB de sortie finale.
| Services | Type | Crédits de base | Charge de taille finale | État |
|---|---|---|---|---|
| Téléchargement vidéo Télécharger la vidéo de YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo ou une autre source prise en charge. |
emploi | 12 | +1 / commencé 10 MB | Disponible |
| Téléchargement audio Extraire l'audio d'une URL multimédia prise en charge. |
emploi | 8 | +1 / commencé 10 MB | Disponible |
| Convertisseur d'image et éditeur en vrac Convertir, redimensionner, recadrer, tourner et modifier une ou plusieurs images téléchargées. |
emploi | 5 | +1 / commencé 10 MB | Disponible |
| Convertisseur audio Convertir un fichier audio téléchargé. |
emploi | 5 | +1 / commencé 10 MB | Disponible |
| Convertisseur vidéo Convertir une vidéo téléchargée avec un préréglage FFmpeg autorisé pour YouTube, Instagram Reels ou TikTok Shorts. |
emploi | 12 | +1 / commencé 10 MB | Handicapés temporaires |
| Convertisseur d'archives Créer ou convertir une archive téléchargée. |
emploi | 5 | +1 / commencé 10 MB | Disponible |
| Convertisseur de documents Convertir un document téléchargé avec Pandoc. |
emploi | 5 | +1 / commencé 10 MB | Handicapés temporaires |
| IA image upscaler Mettre à niveau une image téléchargée avec un modèle ESRGAN pris en charge. |
emploi | 25 | +1 / commencé 10 MB | Disponible |
| Vérificateur Proxy Vérifiez un lot de HTTP, HTTPS ou SOCKS proxies. |
emploi | 1 / 5 Éléments | Aucune | Disponible |
| Convertisseur d'unité synchrone Fonctionnement du convertisseur d'unité. |
utilité | 1 | Aucune | Disponible |
| Utilitaires texte synchrone Fonctionnement des utilitaires texte. |
utilité | 1 | Aucune | Disponible |
Authentification
Envoyez la clé comme jeton porteur. Elle n'est montrée qu'une fois lorsqu'elle est créée ou tournée.
Limites et charge
La clé utilise la même limite de crédits et de fonctionnement/minute que le compte Web. Une utilitaire réussie est facturée immédiatement; un emploi asynchrone se réserve des crédits et les règle après l'achèvement.
Docs lisibles par machine
Obtenez le document authentifié OpenAPI 3.1 avec le même en-tête porteur.
Référence du service
Toutes les opérations de l'API et les champs requis sont énumérés ci-dessous. Ajouter Idempotency-Key lors d'une nouvelle demande.
POST /api/uploads — attribuer les téléchargements de fichiers
Pour imagick, esrgan, video_convert, audio_convert, archive, pandoc, attribuer d'abord un ou plusieurs noms de fichiers. Télécharger chaque fichier avec tus dans le retour upload_url, préserver les métadonnées de fichier retournées. Puis soumettre le jeton retourné, ou files[].relative_path pour Pandoc, pour /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"
}
}
Télécharger avec tus 1.0: créer la ressource de téléchargement à upload_url. Les deux token et filename dans Upload-Metadata sont des valeurs codées de base64. La réponse renvoie l'URL de la ressource récupérable dans son Location en-tête.
Envoie les octets à ça Location. Si un transfert reprend, obtenir le décalage actuel avec un tus HEAD demander et envoyer cette valeur comme Upload-Offset.
POST /api/convert — Téléchargement vidéo
Télécharger la vidéo de YouTube, TikTok, Reddit, Instagram, Facebook, Twitch, X, Vimeo ou une autre source prise en charge. Prix de base: Crédit(s) 12, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
type | string|required |
url | string|required |
format | string|optional |
quality | string|optional |
fps | integer|optional |
playlist | boolean|optional |
source_service | string|optional |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Téléchargement audio
Extraire l'audio d'une URL multimédia prise en charge. Prix de base: Crédit(s) 8, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
type | string|required |
url | string|required |
format | mp3|m4a|flac|aac |
quality | string|optional |
playlist | boolean|optional |
source_service | string|optional |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Convertisseur d'image et éditeur en vrac
Convertir, redimensionner, recadrer, tourner et modifier une ou plusieurs images téléchargées. Prix de base: Crédit(s) 5, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
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) |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Convertisseur audio
Convertir un fichier audio téléchargé. Prix de base: Crédit(s) 5, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Convertisseur vidéo
Convertir une vidéo téléchargée avec un préréglage FFmpeg autorisé pour YouTube, Instagram Reels ou TikTok Shorts. Prix de base: Crédit(s) 12, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
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 |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Convertisseur d'archives
Créer ou convertir une archive téléchargée. Prix de base: Crédit(s) 5, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
output_format | string|required |
max_output_bytes | integer|optional |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Convertisseur de documents
Convertir un document téléchargé avec Pandoc. Prix de base: Crédit(s) 5, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
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) |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — IA image upscaler
Mettre à niveau une image téléchargée avec un modèle ESRGAN pris en charge. Prix de base: Crédit(s) 25, Plus 1 crédit(s) par crédit 10 MB de sortie finale.
| Champ | Type/exigence |
|---|---|
type | string|required |
token | string|required (from POST /api/uploads) |
model | string|optional |
scale | integer|optional (2-4) |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/convert — Vérificateur Proxy
Vérifiez un lot de HTTP, HTTPS ou SOCKS proxies. Prix de base: Crédit(s) 1.
| Champ | Type/exigence |
|---|---|
type | string|required |
proxies | array|required |
default_protocol | string|optional |
timeout_sec | integer|optional |
connect_timeout_sec | integer|optional |
test_url | url|optional |
Retours reçus token, state, status_url, download_url et le crédit réservé.
POST /api/utilities/unit-convert — Convertisseur d'unité
synchrone Fonctionnement du convertisseur d'unité. Prix de base: Crédit(s) 1.
| Champ | Type/exigence |
|---|---|
category | string|required |
from | string|required |
to | string|required |
value | number|required |
precision | integer|optional |
Cet utilitaire répond synchronement à son résultat et à son utilisation chargée.
POST /api/utilities/text — Utilitaires texte
synchrone Fonctionnement des utilitaires texte. Prix de base: Crédit(s) 1.
| Champ | Type/exigence |
|---|---|
text | string|required |
operations | array|optional |
Cet utilitaire répond synchronement à son résultat et à son utilisation chargée.
Exemple de statut et de téléchargement
Sondage seulement status_url est revenu pour votre travail. Quand son état est finished et ready est vrai, suivez download_url; les emplois échoués et annulés libèrent leurs crédits réservés.
{
"ok": true,
"data": {
"token": "JOB_TOKEN",
"state": "finished",
"ready": true,
"download_url": "https://ampx.cc/d/JOB_TOKEN"
}
}
Contrat d'erreur
Erreurs d'utilisation {"ok":false,"error":{"code":"…","message":"…"}}. L'accès nécessite un régime payant effectif plus l'ajout d'API séparé, ou une subvention d'administrateur avec accès d'API activé.
| 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 |