ಅನುರೋಧ ಶೀರ್ಷಿಕೆ
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_ ನಿಂದ ಪ್ರಾರಂಭವಾಗುವ ಕೀಲನ್ನು ರಚಿಸಿ. ಪ್ರತಿ ಅಪ್ಲಿಕೇಶನ್ಗೆ ಪ್ರತ್ಯೇಕ ಕೀಲನ್ನು ಬಳಸಿ ಮತ್ತು ಅದಕ್ಕೆ ಬಜೆಟ್ ನಿಗದಿಪಡಿಸಿ.
ಕೀಯನ್ನು ಅದನ್ನು ರಚಿಸಿದ ಖಾತೆಗಾಗಿ ಬಳಸಿ. ಅದನ್ನು ಸರ್ವರ್ನಲ್ಲಿಟ್ಟು, ಪರಿಸರ ಚ biến量ದಿಂದ ಓದಿ; ಅದನ್ನು ಯಾವತ್ತೂ ವೆಬ್ ಪುಟದ ಮೂಲ ಕೋಡ್ ಅಥವಾ ಸಾರ್ವಜನಿಕ ನಿಲ್ದಾಣದಲ್ಲಿ ಇರಿಸಬೇಡಿ.
ಬ್ಯಾಲೆನ್ಸ್ ಪರಿಶೀಲಿಸಿ
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 ಕಾರ್ಯಪ್ರವಾಹ ಮತ್ತು ಅನುವಾದ ವಿನಂತಿ ಕ್ಷೇತ್ರಗಳು .
ಪ್ರತಿ ಎಂಟ್ರಿಯು ಮಾರ್ಗಗಳು, ವಿನಂತಿ ಕ್ಷೇತ್ರಗಳು ಮತ್ತು ಉದಾಹರಣೆಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುತ್ತದೆ. ನಿಮ್ಮ ಖಾತೆಯ ಸೇವಾ ಸ್ಥಿತಿ ಮತ್ತು ನಿಮ್ಮ ಕೀಲಿಯ ಮಿತಿಗಳು ಅವುಗಳೆಲ್ಲಕ್ಕೂ ಅನ್ವಯಿಸುತ್ತವೆ.
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 | ತಾತ್ಕಾಲಿಕ ಸೇವಾ ದೋಷ | ಸೀಮಿತ ಘಾತೀಯ ಹಿಂದೆ ಸರಿಯುವಿಕೆ; create ವಿನಂತಿಗಳಿಗೆ idempotency ಕೀಲಿಯನ್ನು ಉಳಿಸಿಕೊಳ್ಳಿ |
X-Request-Id ಪ್ರತಿಕ್ರಿಯೆ ಹೆಡರ್, ವಿನಂತಿ ಸಮಯ ಮತ್ತು ದಾರಿಯನ್ನು ತಪಾಸಣೆಗಾಗಿ ಉಳಿಸಿ; ಸಂಪೂರ್ಣ ಕೀಲಿಯನ್ನು ಎಂದಿಗೂ ಲಾಗ್ ಮಾಡಬೇಡಿ. ಎಲ್ಲಾ ದೋಷ ಕೋಡ್ಗಳು ಮತ್ತು ಪುನಃ ಪ್ರಯತ್ನಿಸುವ ಉದಾಹರಣೆಗಳು error reference ನಲ್ಲಿವೆ.
ಕ್ರೆಡಿಟ್ಗಳಿಲ್ಲ
ಅಪ್ಲೋಡ್ ಮಾಡುವುದು, ಜಾಬ್ಗಳನ್ನು ಪರಿಶೀಲಿಸುವುದು, ಫಲಿತಾಂಶಗಳನ್ನು ಡೌನ್ಲೋಡ್ ಮಾಡುವುದು ಮತ್ತು ಬ್ಯಾಲೆನ್ಸ್ ಹಾಗೂ ಸೆಟಲ್ಮೆಂಟ್ ರೆಕಾರ್ಡ್ಗಳನ್ನು ಓದುವುದಕ್ಕೆ ಯಾವುದೇ ಕ್ರೆಡಿಟ್ ವೆಚ್ಚವಾಗುವುದಿಲ್ಲ; ಗ್ಲಾಸರಿಗಳು, ಪ್ರಾಜೆಕ್ಟ್ಗಳು, ಟ್ಯಾಗ್ಗಳು, ಹುಡುಕಾಟ ಮತ್ತು ಹಂಚಿಕೆಗೂ ಕೂಡ ಹಣ ಖರ್ಚಾಗುವುದಿಲ್ಲ.
ಬಳಕೆಯ ಆಧಾರದ ಮೇಲೆ ಶುಲ್ಕ ವಿಧಿಸಲಾಗುತ್ತದೆ
ಕಡತ ಅನುವಾದ, ದಾಖಲೆ ಸಾಧನಗಳು, ತಕ್ಷಣದ ಅನುವಾದ ಮತ್ತು ಆಡಿಯೋ ಹಾಗೂ ವೀಡಿಯೋ ಸೇವೆಗಳು ಅವುಗಳ ಬೆಲೆಗಳನ್ನು ನಿರ್ಧರಿಸಲಾಗುತ್ತದೆ; ಕೆಲಸವನ್ನು ರಚಿಸುವುದು ಅಂತಿಮ ಶುಲ್ಕವಲ್ಲ.
ಕೆಲಸ ಪ್ರಾರಂಭವಾಗುವ ಮೊದಲು, ಬ್ಯಾಲೆನ್ಸ್ ಥ್ರೆಶೋಲ್ಡ್ ಅನ್ನು ಮಾತ್ರ ಪರಿಶೀಲಿಸಲಾಗುತ್ತದೆ; ಕೆಲಸ ಮುಗಿದ ನಂತರ, ನಿಜವಾದ ಬಳಕೆಯನ್ನು ಶುಲ್ಕ ವಿಧಿಸಲಾಗುತ್ತದೆ. ಬ್ಯಾಲೆನ್ಸ್ ಕಡಿಮೆಯಾದರೆ, ವ್ಯತ್ಯಾಸವನ್ನು ಸಾಲವಾಗಿ ದಾಖಲಿಸಲಾಗುತ್ತದೆ, ಮತ್ತು ನಂತರ ಬರುವ ಕ್ರೆಡಿಟ್ಗಳು ಅದನ್ನು ಮೊದಲು ತೀರಿಸುತ್ತವೆ. ನೀವು ಪ್ರತಿ ಕೆಲಸ ಅಥವಾ ಪ್ರತಿ ಕ್ರೆಡಿಟ್ ಕಾರ್ಯಾಚರಣೆಗೆ ಸಂಬಂಧಿಸಿದಂತೆ ಶುಲ್ಕ ಮತ್ತು ರಿಫಂಡ್ಗಳನ್ನು ಹೊಂದಿಸಬಹುದು. ಒಂದು ಕೀಲಿಯ ಬಜೆಟ್ ಖಾಲಿಯಾದರೂ, ಆ ಕೀಲಿಯಡಿಯಲ್ಲಿರುವ ಕೆಲಸಗಳು, ಫಲಿತಾಂಶಗಳು ಮತ್ತು ದಾಖಲೆಗಳನ್ನು ಇನ್ನೂ ಪ್ರಶ್ನಿಸಬಹುದು.