छवि अनुकूलन API एंडपॉइंट
मुख्य छवि प्रसंस्करण एंडपॉइंट POST /v1/optimize के लिए आधिकारिक तकनीकी संदर्भ।
छवियों को अनुकूलित, प्रारूप परिवर्तित, डाउनस्केल और आकार बदलने के लिए प्राथमिक एंडपॉइंट है:
POST https://api.smallpict.app/v1/optimize
(उपनाम: POST https://api.smallpict.app/v1/convert)
अनुरोध प्रारूप (JSON पेलोड)
POST /v1/optimize HTTP/1.1Host: api.smallpict.appX-API-Key: sp_sdk_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0bX-Timestamp: 1716301234X-Signature: 3a9f8b2c4d6e8a0f1b3c5d7e9f2a4b6c8d0e1f3a5b7c9d1e3f5a7b9c1d3e5f7aContent-Type: application/jsonIdempotency-Key: c9b8a7f6-e5d4-4c3b-2a1f-0e9d8c7b6a5fअनुरोध बॉडी स्कीमा
{ "filename": "hero-banner.jpg", "mime_type": "image/jpeg", "filesize": 1654200, "options": { "format": "avif", "quality": 80, "max_dimension": 1600, "max_width": 1920, "max_height": 1080, "lossless": false, "strip_metadata": true }}| फ़ील्ड | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
filename | string | हाँ | छवि फ़ाइल का मूल नाम (उदा. banner.png) |
mime_type | string | हाँ | MIME प्रकार (उदा. image/jpeg, image/png, image/webp) |
filesize | integer | हाँ | बाइट्स में कुल फ़ाइल आकार (> 0 होना चाहिए) |
options.format | string | नहीं | लक्षित प्रारूप: avif, webp, original / keep, jpg, png (डिफ़ॉल्ट: webp) |
options.quality | integer | नहीं | 1 से 100 के बीच संपीड़न गुणवत्ता (डिफ़ॉल्ट: 80) |
options.max_dimension | integer | नहीं | पिक्सेल में सबसे लंबे किनारे का आनुपातिक आयाम प्रतिबंध (उदा. 1600, 1920, 2048, 2560) |
options.max_width | integer | नहीं | अधिकतम चौड़ाई पिक्सेल सीमा |
options.max_height | integer | नहीं | अधिकतम ऊंचाई पिक्सेल सीमा |
options.lossless | boolean | नहीं | पिक्सेल-सटीक दोषरहित संपीड़न सक्षम करें (डिफ़ॉल्ट: false) |
options.strip_metadata | boolean | नहीं | कैमरा EXIF और रंग प्रोफ़ाइल मेटाडेटा हटाएं (डिफ़ॉल्ट: true) |
प्रत्यक्ष छवि ट्रांसफार्मर पैरामीटर
क्लाउड ट्रांसफार्मर मार्ग तत्काल रूपांतरण और आकार बदलने के लिए क्वेरी पैरामीटर स्वीकार करते हैं:
GET https://api.smallpict.app/v1/transform?url=...&format=webp&quality=80&max_dimension=1600
?format=avif|webp|original?quality=1..100?max_dimension=1600?max_width=1920?max_height=1080
सर्वर प्रतिक्रिया (200 OK)
सफलतापूर्वक आरंभ होने पर, SmallPict एक सुरक्षित अपलोड URL और कार्य ट्रैकर आईडी लौटाता है:
{ "upload_url": "https://upload.smallpict.app/uploads/a1b2c3d4/hero-banner.jpg?signature=...", "job_id": "job-a1b2c3d4", "object_key": "uploads/a1b2c3d4/hero-banner.jpg", "status": "queued"}इमेज के बाइट्स को HTTP PUT अनुरोध के साथ upload_url पर अपलोड करें, फिर कार्य की स्थिति जाँचें। सुरक्षित अपलोड लिंक को ठीक वैसे ही इस्तेमाल करें जैसा लौटाया गया है: यह कुछ समय बाद समाप्त हो जाता है और केवल इसी अपलोड के लिए काम करता है।
कार्य की स्थिति जांचें
रूपांतरण की प्रगति की जाँच इस प्रकार करें:
GET https://api.smallpict.app/v1/optimize/status?job_id=job-a1b2c3d4
पूर्ण होने पर प्रतिक्रिया (200 OK)
{ "job_id": "job-a1b2c3d4", "status": "completed", "url": "https://cdn.smallpict.app/opt/hero-banner.avif", "format": "avif", "bytes_saved": 1456200, "savings_percentage": 88.03, "created_at": "2026-08-23T08:00:00Z", "updated_at": "2026-08-23T08:00:01Z"}