API
Quatre endpoints : obtenir une URL d'envoi, créer une tâche, consulter le résultat, relancer une tâche échouée. Avec les règles de paramètres, les états et les erreurs.
POST
API de téléchargement d’image
/api/img_upload
cURL
curl -X POST https://bigjpg.com/api/img_upload \
-H 'X-API-KEY: YOUR_API_KEY' \
-d 'filename=small.jpg' \
-d 'filetype=image/jpeg'
# Use url from the response to upload the file to R2.
curl -X PUT --upload-file small.jpg \
-H 'Content-Type: image/jpeg' \
'UPLOAD_URL'
Python
import requests
filename = 'small.jpg'
filetype = 'image/jpeg'
r = requests.post(
url='https://bigjpg.com/api/img_upload',
headers={'X-API-KEY': 'YOUR_API_KEY'},
data={'filename': filename, 'filetype': filetype}
)
upload = r.json()
with open(filename, 'rb') as image:
requests.put(
url=upload['url'],
data=image,
headers={'Content-Type': filetype}
)
print(upload['fileurl']) # use as input in the enlarge API
- Les membres payants peuvent utiliser l’API
- Appelez cet endpoint avec votre clé API pour obtenir une URL temporaire de téléversement R2 et l’URL publique de l’image
- Téléversez le fichier avec PUT en utilisant le même Content-Type, puis utilisez fileurl comme input dans l’API d’agrandissement
- URL de base:
https://bigjpg.com
POST
Enlarge API
/api/task/
cURL
curl -d '{"style": "art", "noise": "3", "x2": "1", "input": "YOUR_IMAGE_URL"}' \
-H 'X-API-KEY: YOUR_API_KEY' \
https://bigjpg.com/api/task/
Python
import json
import requests
data = {
'style': 'art',
'noise': '3',
'x2': '1',
'file_name': 'small.jpg',
'input': 'YOUR_IMAGE_URL'
}
r = requests.post(
url='https://bigjpg.com/api/task/',
headers={'X-API-KEY': 'YOUR_API_KEY'},
data=json.dumps(data)
)
print(r.json())
- JSON format
- style can be 'art', 'photo' which means 'cartoon illustration', 'photo'
- noise can be '-1', '0', '1', '2', '3' which means 'None', 'Low, 'Medium', 'High', 'Highest'
- x2 can be '1', '2', '3', '4' which means 2x, 4x, 8x, 16x
- input your enlarge image url
- Un appel réussi renvoie tid (identifiant de la tâche), minute (durée estimée) et remaining_api_calls (appels restants).
GET
Result Query API
/api/task/{task_ids}
cURL
curl https://bigjpg.com/api/task/tid1,tid2,tid3,tid100
Python
import requests
r = requests.get(
url='https://bigjpg.com/api/task/tid1,tid2,tid3,tid100'
)
print(r.json())
- Plusieurs identifiants peuvent être passés séparés par des virgules — jusqu'à 100 par requête.
- Chaque tâche revient sous la forme {"status": ..., "url": ..., "size": ...} ; status vaut new, process, success ou error.
- url et size restent vides tant que la tâche n'est pas terminée.
POST
Task retry API
/api/task/{task_ids}
cURL
curl -X POST https://bigjpg.com/api/task/tid1,tid2,tid3,tid100
Python
import requests
r = requests.post(
url='https://bigjpg.com/api/task/tid1,tid2,tid3,tid100'
)
print(r.json())
Réponses d'erreur
status
- valid_api_key_required — l'en-tête X-API-KEY est absent ou inconnu. Vérifiez son nom et que la clé appartient à un compte payant encore valide.
- requires_vip — le compte est gratuit ou expiré. L'API demande une formule payante active.
- month_limit — le quota mensuel est épuisé. Chaque appel réussi renvoie remaining_api_calls, ce qui permet d'anticiper.
- param_error — paramètres hors plage : style doit valoir art ou photo, noise de -1 à 3, x2 de 1 à 4 (1 à 2 pour un compte gratuit).
- input_url_error — input doit être une URL d'image http:// ou https:// accessible publiquement.
X-API-KEY: Les membres payants peuvent utiliser l’API
Contactez-nous à l'adresse i@bigjpg.com pour plus d'appels API