கோரிக்கை தலைப்பு
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 பதில் தலைப்பு, கோரிக்கை நேரம் மற்றும் பாதையைப் பராமரிக்கவும்; முழு விசையையும் ஒருபோதும் பதிவு செய்ய வேண்டாம். அனைத்து பிழை குறியீடுகள் மற்றும் மீண்டும் முயற்சி எடுத்துக்காட்டுகள் error reference-இல் உள்ளன.
கடன்கள் இல்லை
பதிவேற்றம், பணிகளைச் சரிபார்த்தல், முடிவுகளைப் பதிவிறக்கம் செய்தல் மற்றும் இருப்பு மற்றும் தீர்வுப் பதிவுகளைப் படித்தல் ஆகியவற்றிற்கு எந்த கிரெடிட்டும் கட்டணம் இல்லை; க்ளாஸரி, திட்டங்கள், குறிச்சொற்கள், தேடல் மற்றும் பகிர்வு ஆகியவற்றிற்கும் கட்டணம் இல்லை.
பயன்பாட்டின் அடிப்படையில் கட்டணம்
கோப்பு மொழிபெயர்ப்பு, ஆவணக் கருவிகள், உடனடி மொழிபெயர்ப்பு மற்றும் ஒலி மற்றும் காணொளி சேவைகள் அவற்றின் விலைகள் உண்மையான பயன்பாட்டின் அடிப்படையில் நிர்ணயிக்கப்படுகின்றன; ஒரு பணி உருவாக்கப்படுவது இறுதி கட்டணம் அல்ல.
பணி தொடங்கும் முன், இருப்பு வரம்பு மட்டுமே சரிபார்க்கப்படுகிறது; பணி முடிந்த பின், உண்மையான பயன்பாடு கட்டணமாக வசூலிக்கப்படுகிறது. இருப்பு போதாமை ஏற்பட்டால், அத்துக்குரிய வேறுபாடு கடனாகப் பதிவு செய்யப்படும், மேலும் பின்னர் வரும் கிரெடிட்கள் முதலில் அதை அடைக்கும். ஒவ்வொரு பணிக்கும் அல்லது ஒவ்வொரு கிரெடிட் செயல்பாட்டிற்கும் கட்டணங்கள் மற்றும் திரும்பப் பணம் ஆகியவற்றை ஒப்பிட்டுப் பார்க்கலாம். ஒரு விசையின் பட்ஜெட் முடிந்துவிட்டாலும், அந்த விசைக்குட்பட்ட பணிகள், முடிவுகள் மற்றும் பதிவுகளை இன்னும் வினவலாம்.