कोड से PDF123 कैसे इस्तेमाल करें?
चारों इंटरफ़ेस एक ही ऑपरेशन चलाते हैं, इसलिए मर्ज का नतीजा हर जगह एक जैसा मिलता है। अपना कोड जहाँ चलता है, उसके हिसाब से चुनें।
| इंटरफ़ेस | किसके लिए बेहतर | इंस्टॉल या पता | गाइड |
|---|---|---|---|
| REST API | कोई भी भाषा, सर्वर, शेल स्क्रिप्ट | https://pdf123.xyz/api/v1 | API संदर्भ |
| TypeScript SDK | टाइप चाहने वाला Node, Bun और ब्राउज़र कोड | npm install @pdf123/sdk | SDK गाइड |
| कमांड लाइन | टर्मिनल, CI जॉब, स्थानीय फ़ाइलों के बैच | npm install -g @pdf123/cli | CLI गाइड |
| MCP | Claude Code, Claude Desktop और Cursor जैसे AI एजेंट | npx -y @pdf123/mcp या https://pdf123.xyz/mcp | MCP गाइड |
कोड TypeScript में नहीं है तो REST API इस्तेमाल करें। TypeScript में है तो SDK लें, क्योंकि टूल के विकल्प टाइप किए होते हैं और अपलोड से पहले जाँचे जाते हैं। एक बार के काम और शेल स्क्रिप्ट के लिए कमांड लाइन इस्तेमाल करें। जब कौन-सा टूल चलाना है, यह AI एजेंट को तय करना हो, तब MCP इस्तेमाल करें।
कैटलॉग में 97 टूल हैं। इनमें से 58 के पेज इस वेबसाइट पर हैं, जैसे PDF मिलाएँ, PDF बाँटें और PDF संपीड़ित करें। बाकी बैकएंड ऑपरेशन हैं जिनका वेब पेज नहीं है; सभी SDK, कमांड लाइन और MCP में उपलब्ध हैं।
पहला अनुरोध कैसे चलाएँ?
curl से दो फ़ाइलें मिलाएँ। अनुरोध एक multipart फ़ॉर्म है, जिसमें हर फ़ाइल के लिए एक fileInput भाग होता है।
curl -X POST https://pdf123.xyz/api/v1/general/merge-pdfs \
-F [email protected] -F [email protected] \
-o merged.pdfTypeScript SDK से वही मर्ज:
import { Pdf123Client } from "@pdf123/sdk";
import { readFileInput, saveResult } from "@pdf123/sdk/node";
const client = new Pdf123Client();
const result = await client.run("merge", {
input: [await readFileInput("a.pdf"), await readFileInput("b.pdf")],
});
await saveResult(result, { output: "merged.pdf" });कमांड लाइन से वही मर्ज:
npx @pdf123/cli merge a.pdf b.pdf -o merged.pdfप्रमाणीकरण कैसे काम करता है?
सार्वजनिक API पर गुमनाम कॉल के लिए न खाता चाहिए, न कुंजी। जब आप अपना ट्रैफ़िक पहचान में लाना चाहें, या होस्टेड MCP एंडपॉइंट को कॉल करना हो, तो X-API-KEY हेडर में API कुंजी भेजें; होस्टेड एंडपॉइंट के लिए कुंजी हमेशा ज़रूरी है।
नीचे के पैनल में कुंजी बनाने के लिए साइन इन करें, और उसे सुरक्षित जगह रखें।
आपका सत्र जाँचा जा रहा है…
curl -X POST https://pdf123.xyz/api/v1/general/merge-pdfs \
-H "X-API-KEY: <your-key>" \
-F [email protected] -F [email protected] -o merged.pdfSDK कुंजी को apiKey के रूप में लेता है। कमांड लाइन और स्थानीय MCP सर्वर उसे PDFX_API_KEY एनवायरनमेंट वेरिएबल से पढ़ते हैं।
नोट
सेल्फ-होस्ट सर्वर पर SECURITY_CUSTOMGLOBALAPIKEY एनवायरनमेंट वेरिएबल सेट करें; इससे वह एक कुंजी तय होती है जिसे सर्वर स्वीकार करता है। देखें सेल्फ-होस्ट।
API संदर्भ कहाँ है?
REST API के दस्तावेज़ दो रूपों में हैं। Swagger UI में आप हर एंडपॉइंट को ब्राउज़र में आज़मा सकते हैं। OpenAPI दस्तावेज़ क्लाइंट जनरेटर के लिए मशीन-पठनीय स्रोत है।
हर ऑपरेशन बेस URL https://pdf123.xyz/api/v1 के अंतर्गत एक POST है, जो श्रेणी के अनुसार बँटा है। उदाहरण के लिए, मर्ज /general/merge-pdfs है और कंप्रेस /misc/compress-pdf।
एक अनुरोध में कई टूल कैसे जोड़ें?
POST /api/v1/pipeline में fileInput भाग और एक steps फ़ील्ड भेजी जाती है। यह फ़ील्ड ऑब्जेक्ट की JSON ऐरे है, जिसमें हर ऑब्जेक्ट में एक op और वैकल्पिक params होते हैं। हर चरण को पिछले चरण का आउटपुट मिलता है।
curl -X POST https://pdf123.xyz/api/v1/pipeline \
-F [email protected] -F [email protected] \
-F 'steps=[{"op":"general/merge-pdfs"},{"op":"misc/compress-pdf"}]' \
-o out.pdfअनुरोध को सुरक्षित तरीके से दोबारा कैसे भेजें?
किसी भी ऑपरेशन पर Idempotency-Key हेडर भेजें। 24 घंटे के भीतर वही अनुरोध दोबारा आने पर वह फिर से नहीं चलता; पहला नतीजा हेडर Idempotency-Replayed: true के साथ लौटाया जाता है। वही कुंजी किसी दूसरे अनुरोध के लिए इस्तेमाल करने पर अनुरोध अस्वीकार हो जाता है। 32 MiB से बड़े नतीजे सहेजे नहीं जाते, इसलिए ऐसे अनुरोध को दोहराने पर 409 मिलता है और नई कुंजी चाहिए।
आकार और दर की सीमाएँ क्या हैं?
| सीमा | मान |
|---|---|
| वेबसाइट पर फ़ाइल का आकार | प्रति फ़ाइल 500 MB |
| एक सीधे API अनुरोध की बॉडी | 100 MiB, multipart ढाँचा मिलाकर |
| चंक में अपलोड | कुल 95 MB से ऊपर होने पर SDK अपने आप अपलोड API पर चला जाता है |
जवाब में X-RateLimit-Limit, X-RateLimit-Remaining और X-RateLimit-Reset हेडर होते हैं। स्टेटस 429 वाले जवाब में Retry-After भी जुड़ जाता है। कोई तय कोटा मान लेने के बजाय इन हेडर को पढ़ें, क्योंकि सेल्फ-होस्ट सर्वर अपनी सीमाएँ खुद तय करता है। बहुत बड़ी बॉडी पर जो त्रुटि आती है, उसे ब्लॉग पोस्ट अनुरोध के आकार की सीमा में समझाया गया है।
त्रुटि कैसी दिखती है?
विफलता पर application/problem+json लौटता है, जिसमें type, title, status, detail, code, reason और hint फ़ील्ड होती हैं। शाखा reason के आधार पर बनाएँ, और वह न हो तो code पर लौटें। detail का पाठ लोगों के लिए लिखा जाता है और उसमें टूल का कच्चा आउटपुट कभी नहीं होता। सभी कोड त्रुटि कोड पर सूचीबद्ध हैं।
| कोड या कारण | HTTP स्टेटस | मतलब |
|---|---|---|
bad_request | 400 | पैरामीटर या multipart बॉडी अमान्य है |
password_required | 400 | PDF एन्क्रिप्टेड है और पासवर्ड नहीं भेजा गया |
invalid_pdf | 400 | फ़ाइल PDF नहीं है या क्षतिग्रस्त है; PDF सुधारें आज़माएँ |
page_out_of_range | 400 | माँगा गया पृष्ठ मौजूद नहीं है |
not_found | 404 | ऑपरेशन का पथ अज्ञात है |
rate_limited | 429 | कोटा खत्म हो गया; Retry-After तक रुकें |
पहले कौन-से टूल कॉल करें?
ये बारह टूल ज़्यादातर अनुरोध सँभाल लेते हैं। किसी टूल को ब्राउज़र में आज़माने के लिए उसका टूल पेज इस्तेमाल करें।
| टूल पेज | API एंडपॉइंट | CLI कमांड | क्या करता है |
|---|---|---|---|
| मिलाएँ | /general/merge-pdfs | pdfx merge | कई PDF को एक में जोड़ता है |
| बाँटें | /general/split-pages | pdfx split | PDF को अलग फ़ाइलों में बाँटता है |
| संपीड़ित करें | /misc/compress-pdf | pdfx compress | आकार घटाने के लिए PDF स्ट्रीम दोबारा संपीड़ित करता है |
| घुमाएँ | /general/rotate-pdf | pdfx rotate | पृष्ठ की दिशा बदलता है |
| सुरक्षित करें | /security/add-password | pdfx protect | PDF को पासवर्ड से एन्क्रिप्ट करता है |
| अनलॉक करें | /security/remove-password | pdfx unlock | पासवर्ड सुरक्षा हटाता है |
| वॉटरमार्क | /security/add-watermark | pdfx watermark | पाठ या छवि का वॉटरमार्क लगाता है |
| OCR | /misc/ocr-pdf | pdfx ocr | स्कैन किया PDF पढ़कर Markdown लौटाता है |
| PDF से Markdown | /convert/pdf/markdown | pdfx pdf-to-markdown | PDF को Markdown में बदलता है |
| PDF से Word | /convert/pdf/word | pdfx convert-to-word | PDF को संपादन योग्य Word फ़ाइल में बदलता है |
| दस्तावेज़ जानकारी | /security/get-info-on-pdf | pdfx get-info | मेटाडेटा, अनुमतियाँ, फ़ॉन्ट और संरचना बताता है |
| सुधारें | /misc/repair | pdfx repair | क्षतिग्रस्त PDF की संरचना फिर से बनाता है |
एंडपॉइंट https://pdf123.xyz/api/v1 के सापेक्ष हैं। सभी 97 टूल देखने के लिए pdfx list चलाएँ या OpenAPI दस्तावेज़ खोलें।
AI एजेंट से PDF123 कैसे इस्तेमाल करें?
एजेंट इन टूल को तीन तरीकों से इस्तेमाल कर सकता है:
- MCP सर्वर जोड़ें। MCP गाइड में आपकी मशीन की फ़ाइलों के लिए स्थानीय सर्वर
@pdf123/mcpऔरhttps://pdf123.xyz/mcpपर होस्टेड एंडपॉइंट, दोनों समझाए गए हैं। - एजेंट स्किल लोड करें। एजेंट स्किल Claude Code, Codex, Cursor और ऐसे ही टूल के लिए
SKILL.mdफ़ाइलें हैं: एक कैटलॉग के लिए और एक हर टूल के लिए। - साइट इंडेक्स पढ़ें। /llms.txt सादे पाठ में टूल, API और MCP एंडपॉइंट सूचीबद्ध करता है, और
/site.jsonldसाइट को संरचित डेटा के रूप में बताता है।
PDF123 ब्लॉग की पोस्ट "Built for AI Agents, Not Just Browsers" बताती है कि REST API और MCP आपस में कैसे जुड़ते हैं।
क्या PDF123 अपने सर्वर पर चला सकता हूँ?
हाँ। बैकएंड pdfx-server प्रोग्राम है, जो Docker में चलता है। SDK, कमांड लाइन या MCP सर्वर को PDFX_API_BASE से उसकी ओर मोड़ें, और आपकी फ़ाइलें आपके नेटवर्क में ही रहती हैं। सेटअप के लिए सेल्फ-होस्ट और सहायता विकल्पों के लिए एंटरप्राइज़ देखें।
FAQ
क्या PDF123 API मुफ़्त है?
गुमनाम उपयोग के लिए हाँ। सार्वजनिक API पर कॉल के लिए खाता या कुंजी नहीं चाहिए। होस्टेड जवाबों में दर-सीमा के हेडर होते हैं, ताकि क्लाइंट 429 जवाब मिलने से पहले ही अपनी रफ़्तार घटा सके।
क्या मुझे API कुंजी चाहिए?
सार्वजनिक साइट इस्तेमाल करते समय REST API, SDK और कमांड लाइन के लिए नहीं। /mcp पर होस्टेड MCP एंडपॉइंट के लिए हाँ; X-API-KEY हेडर के बिना वह 401 देता है। साइन इन करके आप इसी पेज पर कुंजी बना सकते हैं।
फ़ाइल के आकार की सीमा क्या है?
वेबसाइट प्रति फ़ाइल 500 MB तक स्वीकार करती है। एक सीधे API अनुरोध की बॉडी multipart ढाँचा मिलाकर 100 MiB तक हो सकती है। कुल आकार 95 MB पार करते ही SDK बड़े इनपुट को अपने आप चंक में अपलोड करता है।
क्या मैं API को सेल्फ-होस्ट कर सकता हूँ?
हाँ। सर्वर खुद चलाएँ और API बेस को उसके पते पर सेट करें। SDK, कमांड लाइन और स्थानीय MCP सर्वर, तीनों कस्टम बेस URL स्वीकार करते हैं।
त्रुटि की रिपोर्ट कैसे करूँ?
त्रुटि वाले जवाब से code, reason और detail फ़ील्ड, साथ में अनुरोध का समय कॉपी करें और संपर्क पेज से भेजें। PDF खुद तब तक न भेजें जब तक सहायता टीम उसे न माँगे।
SDK, कमांड लाइन या MCP में से क्या इस्तेमाल करूँ?
TypeScript कोड के भीतर SDK, स्क्रिप्ट और स्थानीय फ़ाइलों के बैच के लिए कमांड लाइन, और जब टूल AI एजेंट चुने तब MCP इस्तेमाल करें। तीनों एक ही कैटलॉग और एक ही सर्वर पर चलते हैं, इसलिए इन्हें मिलाकर भी इस्तेमाल किया जा सकता है।