फ़ाइलें अपलोड करें
अपलोड करने के लिए तीन चरण हैं: अपलोड पता मांगें, फ़ाइल भेजें, दस्तावेज़ की पुष्टि करें। एक बार लिखा गया अपलोड पता 1 घंटे तक मान्य रहता है।
1. अपलोड पता मांगें
Section titled “1. अपलोड पता मांगें”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| क्षेत्र | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
filename | स्ट्रिंग | ✅ | फ़ाइल का नाम; सर्वर एक्सटेंशन से फ़ाइल प्रकार का निर्धारण करता है |
file_size | पूर्णांक | ✅ | बाइट्स में सटीक आकार, 0 से बड़ा |
mime_type | स्ट्रिंग | — | वैकल्पिक; सर्वर इसका उपयोग नहीं करता है |
उत्तर:
{ "document_id": "4q8mx2q9z1k7p6ra", "upload_url": "https://upload.example/...", "upload_headers": { "Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "If-None-Match": "*" }, "finalize_token": "short_lived_token", "expires_in": 3600}2. फ़ाइल भेजें
Section titled “2. फ़ाइल भेजें”PUT को upload_url पर भेजें, जिसका शरीर raw फ़ाइल बाइट्स हों, और upload_headers में दिए गए प्रत्येक हेडर को ठीक उसी रूप में भेजें।
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous responsecurl --fail-with-body -X PUT "$UPLOAD_URL" \ -H "Content-Type: $UPLOAD_CONTENT_TYPE" \ -H "If-None-Match: *" \ --upload-file "report.docx"इस चरण में अपना OmniDoc API कुंजी न भेजें। यदि पता समाप्त हो जाता है या हस्तांतरण विफल हो जाता है, तो एक नया कुंजी मांगें।
3. दस्तावेज़ की पुष्टि करें
Section titled “3. दस्तावेज़ की पुष्टि करें”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}सफलता पर दस्तावेज़ लौटाया जाता है:
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}केवल पुष्टि के बाद ही दस्तावेज़ फ़ाइल लाइब्रेरी में प्रवेश करता है और नौकरियों के लिए उपयोगी हो जाता है।
फ़ाइल नाम
Section titled “फ़ाइल नाम”filename केवल प्रदर्शन के लिए है; इसे पथ या अद्वितीय पहचानकर्ता के रूप में उपयोग न करें। सर्वर अवैध वर्णों को बदलता है और बहुत लंबे नामों के लिए एक सुरक्षित डाउनलोड नाम उत्पन्न करता है।
त्रुटियाँ
Section titled “त्रुटियाँ”| स्थिति | कारण |
|---|---|
400 | अमान्य फ़ाइल नाम या आकार, या अपलोड किया गया आकार मांगे गए आकार से भिन्न है |
401 | क्रेडेंशियल या finalize_token अमान्य या समाप्त हो गया है |
403 | finalize_token दूसरे खाते से संबद्ध है |
410 | अपलोड की गई फ़ाइल नहीं मिली (स्थानांतरण अधूरा या पता समाप्त हो गया); कृपया नया पता माँगें |
413 | फ़ाइल प्रति आकार सीमा से अधिक है |
415 | असमर्थित प्रारूप, या सामग्री एक्सटेंशन से मेल नहीं खाती |
422 | Office फ़ाइल क्षतिग्रस्त है या संरचनात्मक रूप से असुरक्षित है |
429 | अत्यधिक अपलोड |
503 | अपलोड सेवा अस्थायी रूप से अनुपलब्ध है; कृपया बाद में पुनः प्रयास करें |