অনুরোধ হেডার
X-API-Key: sk_… বা Authorization: Bearer sk_… ব্যবহার করুন, প্রতি অনুরোধে এই দুটির মধ্যে একটি। JSON বডিগুলির সাথে Content-Type: application/json প্রেরণ করুন।
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · API কী প্রমাণীকরণ · ফাইল অনুবাদ অসিঙ্ক্রোনাস জব হিসেবে চলে
এই সাইটটি HTTP ক্লাউড API-এর বর্ণনা দেয়।
ফাইল আপলোড করার আগে নিশ্চিত করুন যে আপনার কী এবং নেটওয়ার্ক ঠিকমতো কাজ করছে। ব্যালেন্স চেক করতে কোনো ক্রেডিট খরচ হয় না এবং এর ফলে কোনো অনুবাদ কাজও তৈরি হয় না।
একটি API কী পান
API কনসোলে লগইন করুন এবং sk_ দিয়ে শুরু হওয়া একটি কী তৈরি করুন। প্রতিটি অ্যাপ্লিকেশনের জন্য আলাদা কী ব্যবহার করুন এবং এর জন্য একটি বাজেট নির্ধারণ করুন।
একটি কী সেই অ্যাকাউন্টের জন্য কার্যকর, যা এটি তৈরি করেছে। এটিকে সার্ভারে রাখুন এবং একটি পরিবেশ চলক থেকে পড়ুন; কখনোই এটিকে ওয়েব পৃষ্ঠার সোর্স কোড বা কোনো পাবলিক রিপোজিটরিতে রাখবেন না।
ব্যালেন্স পরীক্ষা করুন
OMNIDOC_API_KEY পরিবেশ চ biến্যটি সেট করুন, তারপর নিচের যেকোনো উদাহরণ চালান। সফলতা প্রদর্শন করলে JSON ফেরত আসবে; 401 এর অর্থ হলো কী-তে কোনো সমস্যা আছে এবং এটি পরীক্ষা করা প্রয়োজন। টিকিট, স্ক্রিনশট বা লগে কখনোই সম্পূর্ণ কী প্রদর্শন করবেন না।
export OMNIDOC_API_KEY="sk_your_key"curl --fail-with-body --silent --show-error \ 'https://omnidoc.top/api/v1/billing/credits/balance' \ -H "X-API-Key: $OMNIDOC_API_KEY"import osimport requests
response = requests.get( "https://omnidoc.top/api/v1/billing/credits/balance", headers={"X-API-Key": os.environ["OMNIDOC_API_KEY"]}, timeout=30,)response.raise_for_status()print(response.json())// Node.js 20+, save as balance.mjsconst apiKey = process.env.OMNIDOC_API_KEY;if (!apiKey) throw new Error('Set OMNIDOC_API_KEY');const response = await fetch('https://omnidoc.top/api/v1/billing/credits/balance', { headers: { 'X-API-Key': apiKey }, signal: AbortSignal.timeout(30_000),});if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);console.log(await response.json());একটি সফল আপলোড কেবল নির্দেশ করে যে ফাইলটি সংরক্ষিত হয়েছে। আপনি একটি জব তৈরি করার পর, এটি চূড়ান্ত অবস্থায় পৌঁছানোর জন্য অপেক্ষা করুন, তারপর এর ফলাফলগুলি তালিকাভুক্ত করুন এবং ডাউনলোড করুন।
| ধাপ | পদ্ধতি এবং পথ | কী রাখতে হবে |
|---|---|---|
| একটি আপলোডের অনুরোধ করুন | POST /upload/presign | upload_url, upload_headers, finalize_token |
| ফাইলটি প্রেরণ করুন | PUT থেকে ফেরত পাওয়া upload_url | সফল প্রতিক্রিয়া; এই অনুরোধে কোনো API কী নেই |
| আপলোড নিশ্চিত করুন | POST /upload/finalize | document.id |
| একটি অনুবাদ তৈরি করুন | POST /jobs | চাকরি id |
| স্ট্যাটাস পরীক্ষা করুন | GET /jobs/{job_id} | completed বা failed |
| ফলাফলগুলি তালিকাভুক্ত করুন | GET /artifacts?job_id={job_id} | আর্টিফ্যাক্ট আইডি এবং ফরম্যাট |
| একটি ফলাফল ডাউনলোড করুন | GET /artifacts/{artifact_id}/download | ফাইলের বাইট এবং প্রতিক্রিয়া ফাইলের নাম |
সরাসরি আপলোডের জন্য, সার্ভার থেকে ঠিক যেভাবে ফেরত দেওয়া হয়েছে তেমনভাবে upload_headers পাঠান, এবং স্টোরেজ ঠিকানায় কখনোই X-API-Key পাঠাবেন না। যদি আপলোড ঠিকানার মেয়াদ শেষ হয় বা স্থানান্তর ব্যর্থ হয়, তাহলে নতুন একটি চান। বিশদ: আপলোড প্রোটোকল , দ্রুত শুরু , সম্পূর্ণ Node.js ওয়ার্কফ্লো এবং অনুবাদ অনুরোধের ক্ষেত্রগুলো ।
প্রতিটি এন্ট্রিতে পথ, অনুরোধের ক্ষেত্র এবং উদাহরণ তালিকাভুক্ত থাকে। আপনার অ্যাকাউন্টের সার্ভিস স্ট্যাটাস এবং আপনার কী-এর সীমা এগুলোর প্রতিটিতেই প্রযোজ্য।
একটি এপিআই কী একটি অ্যাকাউন্টকে শনাক্ত করে। এটি কোনো ফাইলের জন্য পাবলিক ডাউনলোড পাসওয়ার্ড নয়।
অনুরোধ হেডার
X-API-Key: sk_… বা Authorization: Bearer sk_… ব্যবহার করুন, প্রতি অনুরোধে এই দুটির মধ্যে একটি। JSON বডিগুলির সাথে Content-Type: application/json প্রেরণ করুন।
একটি কী কী পর্যন্ত পৌঁছতে পারে
একটি কী শুধুমাত্র সেই সংস্থানগুলিতে অ্যাক্সেস পায় যা এর অ্যাকাউন্ট ব্যবহার করতে পারে; সেবার স্থিতি, কী-এর বাজেট এবং অনুমোদিত অনুবাদ সেটিংস এখনও প্রযোজ্য। অ্যাকাউন্টের পরিবর্তন এবং কী তৈরি, ঘূর্ণন বা বাতিল করা কনসোলে সংঘটিত হয়।
দেখুন প্রমাণীকরণ, বাজেট এবং রোটেশন এবং সেবা এবং অনুমতি ।
একটি সময়সীমা উল্লঙ্ঘন করার অর্থ এই নয় যে কাজটি তৈরি হয়নি। পুনরায় চেষ্টা করা যোগ্য ত্রুটিগুলোকে সংশোধন প্রয়োজন এমন অনুরোধগুলো থেকে আলাদা করুন, যাতে কোনো কিছু দুবার জমা বা প্রক্রিয়াকরণ না হয়।
Idempotency-Key তৈরি করুন; যখন আপনি একই কার্যকলাপটি পুনরায় চেষ্টা করবেন, তখন আসল কী এবং ঠিক একই অনুরোধ বডি পুনরায় ব্যবহার করুন। ডকুমেন্ট অপারেশন, মিডিয়া জব এবং ভয়েস তৈরির জন্য কী প্রয়োজন; অন্যান্য তৈরি এন্ডপয়েন্টগুলির জন্য তাদের রেফারেন্স পৃষ্ঠাগুলি দেখুন।| স্ট্যাটাস | প্রথমে পরীক্ষা করুন | কী করবেন |
|---|---|---|
401 / 403 | কী, অনুমতি, সংস্থানের মালিকানা | আর্থিক বিবরণী বা অনুমতি ঠিক করুন; অন্ধভাবে পুনরায় চেষ্টা করবেন না। |
402 | উপলব্ধ ক্রেডিটসমূহ | টপ আপ করুন, তারপর আবার জমা দিন |
409 | ইডেম্পোটেন্সি কী এবং বডি, রিসোর্স স্টেট | নতুন কোনো অপারেশন শুরু করার আগে প্রাথমিক অপারেশনটি জেনে নিন। |
422 | প্রতিক্রিয়ায় ক্ষেত্রের ত্রুটি | প্যারামিটারগুলি বা ফাইলটি ঠিক করুন |
429 | ব্যবসা code এবং Retry-After | রেট এবং কিউ লিমিটগুলি অপেক্ষা করে পূরণ করা যেতে পারে; ব্যবহৃত হয়ে যাওয়া কী বাজেট প্রথমে বাড়াতে হবে। |
5xx | অস্থায়ী পরিষেবা ত্রুটি | সীমিত ঘাতবিশিষ্ট প্রত্যাবর্তন; নতুন অনুরোধের জন্য আইডেম্পোটেন্সি কী ধরে রাখুন |
ত্রুটি নিরাময়ের জন্য X-Request-Id রেসপন্স হেডার, অনুরোধের সময় এবং পথ রাখুন; কখনোই সম্পূর্ণ কী লগ করবেন না। সকল ত্রুটি কোড এবং পুনরায় চেষ্টার উদাহরণ ত্রুটি রেফারেন্স -এ রয়েছে।
কোনো ক্রেডিট নেই
আপলোড, জব চেকিং, ফলাফল ডাউনলোড এবং ব্যালেন্স ও সেটেলমেন্ট রেকর্ড পড়ার জন্য কোনো ক্রেডিট খরচ হয় না; গ্লোসারি, প্রজেক্ট, ট্যাগ, সার্চ এবং শেয়ারিংয়ের জন্যও একই।
ব্যবহার অনুযায়ী চার্জ করা হয়
ফাইল অনুবাদ, ডকুমেন্ট টুলস, তাৎক্ষণিক অনুবাদ এবং অডিও ও ভিডিও সেবাগুলোর মূল্য প্রকৃত ব্যবহারের ভিত্তিতে নির্ধারিত হয়; জব তৈরি করাই চূড়ান্ত চার্জ নয়।
কাজ শুরু হওয়ার আগে শুধুমাত্র ব্যালেন্সের সীমানা পরীক্ষা করা হয়; কাজ শেষ হওয়ার পর প্রকৃত ব্যবহারের ভিত্তিতে চার্জ করা হয়। ব্যালেন্স যদি অপর্যাপ্ত হয়, তবে তার পার্থক্য ঋণ হিসেবে রেকর্ড করা হয় এবং পরে আসা ক্রেডিট প্রথমে এই ঋণ পরিশোধ করে। আপনি প্রতিটি কাজ বা প্রতিটি ক্রেডিট অপারেশন অনুসারে চার্জ এবং রিফান্ডের মিল রাখতে পারেন। যখন কোনো কী-এর বাজেট শেষ হয়ে যায়, তখনও আপনি সেই কী-এর অধীনে থাকা কাজ, ফলাফল এবং রেকর্ডগুলো অনুসন্ধান করতে পারেন।