API

SigCleaner सर्विस का REST API दस्तावेज़।

प्रत्येक सफल \/api\/clean अनुरोध अकाउंट बैलेंस से 1 प्रोसेसिंग काटता है।

मेथड: बैकग्राउंड हटाना

POST https://sigclean.io/api/clean
ऑथराइज़ेशन
Authorization: Bearer YOUR_API_KEY
अनुरोध पैरामीटर
पैरामीटरप्रकारअनिवार्यविवरण
file multipart file दोनों में से कोई एक PNG, JPG या PDF इमेज।
यदि PDF में कई पेज हैं — तो केवल पहले पेज को प्रोसेस किया जाता है।
url string दोनों में से कोई एक इमेज का डायरेक्ट लिंक
type string नहीं json (डिफ़ॉल्ट) — फ़ाइल लिंक के साथ JSON रिटर्न करें
webp — पारदर्शी बैकग्राउंड के साथ WebP बाइनरी फ़ाइल रिटर्न करें
png — पारदर्शी बैकग्राउंड के साथ PNG बाइनरी फ़ाइल रिटर्न करें
extract string नहीं किसी विशिष्ट तत्व को निकालना। डिफ़ॉल्ट रूप से खाली — स्टैंडर्ड बैकग्राउंड रिमूवल।
signature — बाकी सब कुछ हटाकर केवल हस्तलिखित हस्ताक्षर रखें।
stamp — बाकी सब कुछ हटाकर केवल मुहर की छाप रखें।
aggressive boolean नहीं टेक्स्ट को आक्रामक रूप से हटाना।
जब इसे 1 (true) पर सेट किया जाता है, तो यह आक्रामक रूप से सभी प्रिंट किए गए अक्षरों, संख्याओं और फ़ॉर्म की सीधी काली लाइनों को हटा देता है, और केवल निर्दिष्ट तत्व को छोड़ देता है।
mode string नहीं प्रोसेसिंग मोड। डिफ़ॉल्ट रूप से — standard.
basic — हल्की सफ़ाई। यह केवल बैकग्राउंड हटाता है, बाकी सब कुछ छोड़ देता है।
standard — सामान्य सफ़ाई (Ultra)। बैकग्राउंड और अतिरिक्त तत्वों को हटाता है, जैसे कि टेक्स्ट। अधिकांश मामलों के लिए उपयुक्त।
advanced — गहरी सफ़ाई (Ultra)। स्मार्ट एल्गोरिदम का उपयोग करके इमेज प्रोसेसिंग। कम गुणवत्ता वाली फ़ाइलों या कई बाहरी तत्वों वाली फ़ाइलों के लिए उपयुक्त। इस मोड में, आप निकालने के लिए ऑब्जेक्ट चुन सकते हैं या बाहरी तत्वों की आक्रामक सफ़ाई कर सकते हैं।
name string नहीं «मेरी फ़ाइलें» सूची में प्रदर्शित फ़ाइल का नाम। सफलतापूर्वक प्रोसेस होने पर सहेजा जाता है।
रिस्पॉन्स: type=json
{ "status": "ok", "uuid": "550e8400-e29b-41d4-a716-446655440000", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "remaining": 9, "limit": 10 }
रिस्पॉन्स: type=webp

पारदर्शी बैकग्राउंड वाली बाइनरी WebP फ़ाइल लौटाता है। Content-Type: image/webp.

रिस्पॉन्स: type=png

पारदर्शी बैकग्राउंड वाली बाइनरी PNG फ़ाइल लौटाता है। Content-Type: image/png.

cURL के उदाहरण
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=json"
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ --output result.png
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=webp" \ --output result.webp

एग्रेसिव टेक्स्ट रिमूवल के साथ हस्ताक्षर निकालना:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@document.jpg" \ -F "type=png" \ -F "extract=signature" \ -F "aggressive=1" \ --output signature.png

गहरी सफ़ाई:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ -F "mode=advanced" \ --output result.png
परिणाम डाउनलोड करें
GET https://sigclean.io/api/file/{uuid}

मेथड: फ़ाइलों की सूची

GET https://sigclean.io/api/files

वर्तमान उपयोगकर्ता से संबंधित सभी सफलतापूर्वक प्रोसेस की गई फ़ाइलों की सूची लौटाता है। फ़ाइलें लिंक के माध्यम से उपलब्ध हैं /api/file/{uuid}.

ऑथराइज़ेशन
Authorization: Bearer YOUR_API_KEY
रिस्पॉन्स
{ "status": "ok", "files": [ { "uuid": "550e8400-e29b-41d4-a716-446655440000", "name": "stamp.jpg", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "created_at": "2026-07-01T10:00:00Z", "expires_at": "2027-07-01T10:00:00Z" } ] }
फ़ील्डप्रकारविवरण
uuid string फ़ाइल का यूनीक आइडेंटिफ़ायर
name string | null प्रदर्शित फ़ाइल का नाम (\/api\/clean के दौरान name पैरामीटर से या नाम बदलने के बाद)
url string फ़ाइल डाउनलोड करने के लिए डायरेक्ट लिंक (WebP)
created_at string (ISO 8601) फ़ाइल बनने की तारीख और समय (UTC)
expires_at string | null स्टोरेज समाप्ति तिथि (UTC)।
cURL का उदाहरण
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

मेथड: फ़ाइल हटाना

POST https://sigclean.io/api/files/delete

सर्वर से फ़ाइल को स्थायी रूप से हटाता है। फ़ाइल वर्तमान उपयोगकर्ता की होनी चाहिए।

ऑथराइज़ेशन
Authorization: Bearer YOUR_API_KEY
रिक्वेस्ट बॉडी application\/json
पैरामीटरप्रकारअनिवार्यविवरण
uuid string हाँ \/api\/clean या \/api\/files रिस्पॉन्स से फ़ाइल का UUID।
रिस्पॉन्स
{ "status": "ok" }
त्रुटि कोड
कोडविवरण
401अनधिकृत
404फ़ाइल नहीं मिली या उपयोगकर्ता की नहीं है
422uuid नहीं दिया गया या अमान्य है
cURL का उदाहरण
curl -X POST https://sigclean.io/api/files/delete \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000"}'

मेथड: फ़ाइल का नाम बदलना

POST https://sigclean.io/api/files/rename

प्रदर्शित फ़ाइल का नाम बदलता है। फ़ाइल वर्तमान उपयोगकर्ता की होनी चाहिए।

ऑथराइज़ेशन
Authorization: Bearer YOUR_API_KEY
रिक्वेस्ट बॉडी application\/json
पैरामीटरप्रकारअनिवार्यविवरण
uuid string हाँ \/api\/clean या \/api\/files रिस्पॉन्स से फ़ाइल का UUID।
name string हाँ फ़ाइल का नया प्रदर्शित नाम (255 वर्णों तक)।
रिस्पॉन्स
{ "status": "ok", "name": "stamp.jpg" }
त्रुटि कोड
कोडविवरण
401अनधिकृत
404फ़ाइल नहीं मिली या उपयोगकर्ता की नहीं है
422uuid \/ name नहीं दिया गया या अमान्य है
cURL का उदाहरण
curl -X POST https://sigclean.io/api/files/rename \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000","name":"stamp.jpg"}'

API कुंजियों का प्रबंधन

कुंजियों को प्रबंधित करने के लिए अकाउंट में लॉग इन करना आवश्यक है।