Dokumentasi API Penukaran Imej - REST API untuk Penukaran WebP

Gambaran keseluruhan

API Convert2WebP membolehkan anda menukar imej antara format secara programatik. Hantar permintaan multipart bersama imej anda dan terima fail yang telah ditukar dalam badan respons. Semua pemprosesan berlaku di bahagian pelayan dan biasanya mengambil masa kurang daripada satu saat untuk kebanyakan fail.

URL asas

https://convert2webp.com/api/v1

Pengesahan

Tiada pengesahan diperlukan. API ini percuma dan terbuka. Semua permintaan dihadkan kepada 60 seminit bagi setiap alamat IP.

Pengehadan kadar

Had dikenakan bagi setiap alamat IP. Semua respons termasuk pengepala rate limit.

Had	Saiz fail maksimum	Maksimum fail setiap kelompok
60 permintaan / minit	10 MB setiap fail	20 fail setiap kelompok

Pengepala rate limit disertakan dalam setiap respons: X-RateLimit-Remaining, X-RateLimit-Reset.

Endpoints

Menukar satu imej kepada format sasaran. Menerima multipart/form-data dengan fail imej dan parameter pilihan.

Parameter

Nama	Jenis	Diperlukan	Penerangan
file	File	Diperlukan	Fail imej yang hendak ditukar. Menyokong PNG, JPG, GIF, BMP, TIFF, SVG, AVIF, ICO dan WebP.
output_format	string	Pilihan	Format output sasaran: webp, png, jpg, gif, bmp atau pdf.(lalai: `webp`)
quality	integer	Pilihan	Kualiti output dari 1 (terendah) hingga 100 (tertinggi).(lalai: `80`)
width	integer	Pilihan	Lebar output maksimum dalam piksel. Nisbah aspek dikekalkan.
height	integer	Pilihan	Tinggi output maksimum dalam piksel. Nisbah aspek dikekalkan.
strip_metadata	boolean	Pilihan	Membuang metadata EXIF/IPTC/XMP daripada output.(lalai: `true`)

Respons

200

Data binari imej yang telah ditukarimage/webp

400

Permintaan tidak sah (fail tiada, format tidak disokong, dsb.)application/json

413

Fail terlalu besarapplication/json

429

Had melebihiapplication/json

500

Ralat pelayan dalamanapplication/json

Contoh kod

terminal

curl -X POST https://convert2webp.com/api/v1/convert \
  -F "file=@photo.png" \
  -F "format=webp" \
  -F "quality=80" \
  -o converted.webp

Cuba

Fail

Tiada fail dipilih

Format

Kualiti (80)

Menukar beberapa imej dalam satu permintaan. Mengembalikan arkib ZIP dengan semua fail yang telah ditukar.

Parameter

Nama	Jenis	Diperlukan	Penerangan
files	File[]	Diperlukan	Senarai fail imej untuk ditukar. Maksimum 20 fail bagi setiap permintaan.
format	string	Pilihan	Format output yang digunakan pada semua fail.(lalai: `webp`)
quality	integer	Pilihan	Kualiti output dari 1 hingga 100.(lalai: `80`)

Respons

200

Arkib ZIP yang mengandungi semua imej yang telah ditukarapplication/zip

400

Permintaan tidak sahapplication/json

413

Jumlah payload terlalu besarapplication/json

429

Had melebihiapplication/json

Contoh kod

terminal

curl -X POST https://convert2webp.com/api/v1/batch \
  -F "files=@image1.png" \
  -F "files=@image2.jpg" \
  -F "files=@image3.gif" \
  -F "format=webp" \
  -F "quality=80" \
  -o converted.zip

Menyenaraikan semua format input dan output yang disokong.

Respons

200

Objek JSON yang menyenaraikan format input dan output yang disokongapplication/json

Contoh kod

terminal

curl https://convert2webp.com/api/v1/formats

Contoh respons

response.json

{
  "input": [
    "png", "jpg", "jpeg", "gif", "bmp",
    "tiff", "svg", "avif", "ico", "webp"
  ],
  "output": ["webp", "png", "jpg", "gif", "bmp", "pdf"]
}

Menyemak ketersediaan perkhidmatan.

Respons

200

Status perkhidmatan dan versiapplication/json

Contoh kod

terminal

curl https://convert2webp.com/api/v1/health

Contoh respons

response.json

{
  "status": "ok",
  "version": "1.0.0",
  "timestamp": "2026-04-04T12:00:00.000Z"
}

Kod ralat

Semua respons ralat mengembalikan badan JSON dengan satu error objek yang menerangkan masalah.

error-response.json

{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded. Please wait 30 seconds before retrying."
  }
}

Kod	Nama	Penerangan
400	Permintaan tidak sah	Permintaan tidak dibentuk dengan betul. Semak bahawa semua parameter wajib hadir dan sah.
413	Payload terlalu besar	Fail yang dimuat naik melebihi had 10 MB.
415	Jenis media tidak disokong	Format fail yang dimuat naik tidak disokong untuk penukaran.
429	Terlalu banyak permintaan	Anda telah melebihi had (60 permintaan seminit). Tunggu dan cuba lagi.
500	Ralat pelayan dalaman	Ralat yang tidak dijangka telah berlaku. Jika berterusan, hubungi convert2webp@deployvision.com.