రిక్వెస్ట్ హెడర్
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 రెస్పాన్స్ హెడర్, అభ్యర్థన సమయం మరియు మార్గాన్ని నిల్వ చేయండి; పూర్తి కీని ఎప్పుడూ లాగ్ చేయకండి. అన్ని తప్పు కోడ్లు మరియు పునఃప్రయత్న ఉదాహరణలు తప్పు సూచన లో ఉన్నాయి.
క్రెడిట్లు లేవు
అప్లోడ్ చేయడం, జాబ్లను తనిఖీ చేయడం, ఫలితాలను డౌన్లోడ్ చేయడం మరియు బ్యాలెన్స్ మరియు సెటిల్మెంట్ రికార్డులను చదవడం వంటి వాటికి క్రెడిట్లు ఖర్చు కావు; గ్లాసరీలు, ప్రాజెక్ట్లు, ట్యాగ్లు, శోధన మరియు షేరింగ్కు కూడా ఖర్చు లేదు.
వినియోగాన్ని బట్టి బిల్లింగ్
ఫైల్ అనువాదం, డాక్యుమెంట్ సాధనాలు, తక్షణ అనువాదం మరియు ఆడియో, వీడియో సేవలకు వాస్తవ వినియోగం ప్రకారం ధరలు నిర్ణయించబడతాయి; జాబ్ను సృష్టించడం తుది ఛార్జీ కాదు.
ఒక పని ప్రారంభానికి ముందు, బ్యాలెన్స్ థ్రెషోల్డ్ను మాత్రమే తనిఖీ చేస్తారు; అది పూర్తయిన తర్వాత, వాస్తవ వినియోగాన్ని చార్జ్ చేస్తారు. బ్యాలెన్స్ తక్కువగా ఉంటే, ఆ వ్యత్యాసాన్ని అప్పుగా నమోదు చేస్తారు, మరియు తర్వాత వచ్చే క్రెడిట్లు దాన్ని మొదట చెల్లిస్తాయి. మీరు ప్రతి పని లేదా ప్రతి క్రెడిట్ ఆపరేషన్కు సంబంధించి ఛార్జీలు మరియు రిఫండ్లను సమన్వయం చేయవచ్చు. ఒక కీ యొక్క బడ్జెట్ అయిపోయినప్పటికీ, ఆ కీ కింద ఉన్న పనులు, ఫలితాలు మరియు రికార్డులను ఇప్పటికీ సెర్చ్ చేయవచ్చు.