API
Cztery endpointy: pobranie URL-a do wysyłki, utworzenie zadania, sprawdzenie wyniku i ponowienie nieudanego zadania. Z zasadami parametrów, stanami i błędami.
POST
API przesyłania obrazów
/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
- Płatni użytkownicy mogą korzystać z API
- Wywołaj ten endpoint z kluczem API, aby otrzymać tymczasowy adres przesyłania R2 i publiczny adres obrazu
- Prześlij plik metodą PUT z tym samym Content-Type, a następnie użyj fileurl jako input w API powiększania
- Adres bazowy:
https://bigjpg.com
POST
API powiększania
/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())
- Format JSON
- styl może być ’art', 'photo' co oznacza 'ilustracja', 'zdjęcie'
- noise może być ’-1', '0', '1', '2', '3' co oznacza 'Brak', 'Niski', 'Średni', 'Wysoki', 'Najwyższy'
- x2 może być ’1', '2', '3', '4' co oznacza 2x, 4x, 8x, 16x
- wprowadź adres URL swojego obrazu do powiększenia
- Udane wywołanie zwraca tid (id zadania), minute (szacowany czas) i remaining_api_calls (pozostałe wywołania).
GET
API zapytania o wynik
/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())
- Możesz podać kilka identyfikatorów oddzielonych przecinkami — do 100 na jedno żądanie.
- Każde zadanie wraca jako {"status": ..., "url": ..., "size": ...}; status to new, process, success lub error.
- url i size pozostają puste, dopóki zadanie się nie skończy.
POST
API ponawiania zadania
/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())
Odpowiedzi błędów
status
- valid_api_key_required — brak nagłówka X-API-KEY lub jest nierozpoznany. Sprawdź nazwę nagłówka i to, czy klucz należy do aktywnego płatnego konta.
- requires_vip — konto jest darmowe lub wygasło. API wymaga aktywnego płatnego planu.
- month_limit — miesięczny limit wywołań się skończył. Każde udane wywołanie zwraca remaining_api_calls, więc widać to wcześniej.
- param_error — parametry poza zakresem: style to art lub photo, noise od -1 do 3, x2 od 1 do 4 (na darmowym koncie 1–2).
- input_url_error — input musi być publicznie dostępnym adresem obrazu http:// lub https://.
X-API-KEY: Płatni użytkownicy mogą korzystać z API
Skontaktuj się z nami przez i@bigjpg.com aby uzyskać więcej wywołań API