അഭ്യർത്ഥന തലക്കെട്ട്
ഓരോ അഭ്യർത്ഥനയിലും രണ്ടിൽ ഒന്ന് 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 സജ്ജമാക്കുക, തുടർന്ന് ചുവടെയുള്ള ഏതെങ്കിലും ഉദാഹരണങ്ങൾ പ്രവർത്തിപ്പിക്കുക. വിജയം തിരികെ നൽകുന്നു 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 വർക്ക്ഫ്ലോ പൂർത്തിയാക്കുക, വിവർത്തന അഭ്യർത്ഥന ഫീൽഡുകൾ.
ഓരോ എൻട്രിയും പാതകളും അഭ്യർത്ഥന ഫീൽഡുകളും ഉദാഹരണങ്ങളും പട്ടികപ്പെടുത്തുന്നു. നിങ്ങളുടെ അക്കൗണ്ടിൻ്റെ സേവന നിലയും കീയുടെ പരിധികളും അവയ്ക്കെല്ലാം ബാധകമാണ്.
ഒരു API കീ ഒരു അക്കൗണ്ട് തിരിച്ചറിയുന്നു. ഇത് ഒരു ഫയലിനുള്ള പൊതു ഡൗൺലോഡ് പാസ്വേഡല്ല.
അഭ്യർത്ഥന തലക്കെട്ട്
ഓരോ അഭ്യർത്ഥനയിലും രണ്ടിൽ ഒന്ന് 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 പ്രതികരണ തലക്കെട്ടും അഭ്യർത്ഥന സമയവും ട്രബിൾഷൂട്ടിംഗിനുള്ള പാതയും സൂക്ഷിക്കുക; പൂർണ്ണ കീ ഒരിക്കലും ലോഗ് ചെയ്യരുത്. എല്ലാ പിശക് കോഡുകളും വീണ്ടും ശ്രമിക്കുന്നതിനുള്ള ഉദാഹരണങ്ങളും പിശക് റഫറൻസ് എന്നതിലാണ്.
ക്രെഡിറ്റുകളൊന്നുമില്ല
അപ്ലോഡ് ചെയ്യുന്നതിനും ജോലികൾ പരിശോധിക്കുന്നതിനും ഫലങ്ങൾ ഡൗൺലോഡ് ചെയ്യുന്നതിനും ബാലൻസ്, സെറ്റിൽമെൻ്റ് റെക്കോർഡുകൾ വായിക്കുന്നതിനും ക്രെഡിറ്റുകൾ ആവശ്യമില്ല; ഗ്ലോസറികൾ, പ്രോജക്റ്റുകൾ, ടാഗുകൾ, തിരയൽ, പങ്കിടൽ എന്നിവയുമില്ല.
ഉപയോഗം അനുസരിച്ച് ബിൽ ചെയ്യുന്നു
ഫയൽ വിവർത്തനം, ഡോക്യുമെൻ്റ് ടൂളുകൾ, തൽക്ഷണ വിവർത്തനം, ഓഡിയോ, വീഡിയോ സേവനങ്ങൾ എന്നിവ യഥാർത്ഥ ഉപയോഗം അനുസരിച്ച് അവയുടെ വിലകളിൽ തീർപ്പാക്കുന്നു; ഒരു ജോലി സൃഷ്ടിക്കുക എന്നത് അന്തിമ ചാർജ്ജല്ല.
ഒരു ജോലി ആരംഭിക്കുന്നതിന് മുമ്പ്, ബാലൻസ് ത്രെഷോൾഡ് മാത്രമേ പരിശോധിക്കൂ; അത് പൂർത്തിയായ ശേഷം, യഥാർത്ഥ ഉപയോഗത്തിന് നിരക്ക് ഈടാക്കും. ബാലൻസ് കുറവാണെങ്കിൽ, വ്യത്യാസം കടമായി രേഖപ്പെടുത്തുകയും പിന്നീട് വരുന്ന ക്രെഡിറ്റുകൾ ആദ്യം അത് അടയ്ക്കുകയും ചെയ്യും. ഓരോ ജോലിക്കും ഓരോ ക്രെഡിറ്റ് പ്രവർത്തനത്തിനും നിരക്കുകളും റീഫണ്ടുകളും നിങ്ങൾക്ക് അനുരഞ്ജിപ്പിക്കാനാകും. ഒരു കീയുടെ ബജറ്റ് ഉപയോഗിക്കുമ്പോൾ, ആ കീയുടെ കീഴിലുള്ള ജോലികളും ഫലങ്ങളും റെക്കോർഡുകളും നിങ്ങൾക്ക് തുടർന്നും അന്വേഷിക്കാനാകും.