跳转到内容

దస్త్రం మరియు ఫైల్ సాధనాలు

OmniDoc సమకాలీన ఫైల్ సాధనాలను మరియు ట్రాక్ చేయగల అసమకాలీన డాక్యుమెంట్ ఆపరేషన్‌లను అందిస్తుంది. మొదట సామర్థ్య ఎండ్‌పాయింట్‌లను పిలవండి; క్లయింట్‌లో మద్దతు ఉన్న ఫార్మాట్‌లు లేదా పరిమితులను హార్డ్‌కోడ్ చేయవద్దు.

సామర్థ్య ఆవిష్కరణ

Section titled “సామర్థ్య ఆవిష్కరణ”
GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

ఇవి ప్రస్తుతం తెరిచి ఉన్న ఆపరేషన్‌లు, వాటి ఇన్‌పుట్ ఫార్మాట్‌లు, బిల్లింగ్ మరియు సాంకేతిక పరిమితులను తిరిగి ఇస్తాయి. unavailable కింద జాబితా చేయబడిన సామర్థ్యాలను సృష్టించలేరు.

అసింక్రోనస్ డాక్యుమెంట్ ఆపరేషన్‌లు

Section titled “అసింక్రోనస్ డాక్యుమెంట్ ఆపరేషన్‌లు”
POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

ఈ ఎండ్‌పాయింట్‌కు Idempotency-Key అవసరం. kind ప్రస్తుతం కలిగి ఉన్నది:

  • extract: నిర్మాణాత్మక వెలికితీత, ఉచితం.
  • pdf_to_html: PDF నుండి ఆన్‌లైన్ HTML, ఉచితం.
  • visual_extract: దృశ్య నిర్మాణాత్మక వెలికితీత, ప్రతి పేజీకి ఛార్జ్ చేయబడుతుంది (ప్రతి పేజీకి 1 క్రెడిట్). ఇది ప్రారంభమయ్యే ముందు, ఇది ప్రాసెస్ చేయగల పేజీల సంఖ్యను బ్యాలెన్స్ నుండి సెట్ చేస్తుంది (గరిష్టంగా 20 పేజీలు); ఒకవేళ బ్యాలెన్స్ 1 పేజీ కంటే తక్కువ అయితే, ఇది 402 ను రిటర్న్ చేస్తుంది. ఇది పూర్తయినప్పుడు, వాస్తవంగా ప్రాసెస్ చేసిన పేజీలకు ఛార్జ్ చేయబడుతుంది మరియు బ్యాలెన్స్ ఋణాత్మకం కావచ్చు.

ప్రశ్నించండి మరియు రద్దు చేయండి:

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

ఇది పూర్తయినప్పుడు, స్పందన output_document_id ఫైల్ లైబ్రరీ లేదా మరొక జాబ్‌లోకి వెళ్ళవచ్చు, మరియు credit_operation_id సెటిల్‌మెంట్ రికార్డ్‌ను ఇస్తుంది.

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

మెర్జ్ ఉదాహరణ:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

విడదీసే ఉదాహరణ:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

సాధనాలు ప్రస్తుత ఖాతాకు చెందిన మరియు రకం సరిపోయే డాక్యుమెంట్‌లను మాత్రమే అంగీకరిస్తాయి. బైనరీ ప్రతిస్పందనలను స్ట్రీమ్ చేయండి మరియు ఫైల్ పేరు మరియు రకాన్ని ప్రతిస్పందన హెడర్‌ల నుండి తీసుకోండి.