ఉద్యోగ స్థితి
GET /api/v1/jobs/{job_id}ఒక క్వెరీ కేవలం స్టేటస్ను మాత్రమే చదువుతుంది మరియు ఎటువంటి క్రెడిట్లను వినియోగించదు.
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"జీవిత చక్ర స్థితులు
Section titled “జీవిత చక్ర స్థితులు”status | అర్థం |
|---|---|
pending | సృష్టించబడింది, క్యూలో వేచి ఉంది |
processing | ప్రాసెస్ చేయబడుతోంది |
completed | పూర్తయింది; ఫలితాలను చదవవచ్చు |
failed | విఫలమైనది లేదా రద్దు చేయబడింది; error_msg చూడండి |
status పని ముగిసిందో లేదో మీకు తెలియజేస్తుంది.
పురోగతి దశలు
Section titled “పురోగతి దశలు”stage | అర్థం |
|---|---|
queued | క్యూలో |
accepted / preflight | అంగీకరించబడింది మరియు సిద్ధం చేయబడుతోంది |
translating | అనువదించడం |
writing_artifacts / finalizing | ఫలితాలను ఉత్పత్తి చేయడం మరియు నమోదు చేయడం |
completed / failed | ముగింపు |
stage_progress అనేది 0 నుండి 100 వరకు ప్రదర్శించే పురోగతి; ఇది బిల్లింగ్ కోసం ఉపయోగించబడదు. క్యూలో ఉన్నప్పుడు, queue_position ముందున్న పనుల సంఖ్యను లేదా null గా ఇవ్వవచ్చు.
జాబితా చేయండి మరియు రద్దు చేయండి
Section titled “జాబితా చేయండి మరియు రద్దు చేయండి”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelరద్దు చేయడం అనేది ఉత్తమ ప్రయత్నం; ఇప్పటికే ముగిసిన పని $ x $ 409 ని తిరిగి ఇస్తుంది. రద్దు చేసిన పనులకు ఛార్జీలు వసూలు చేయబడవు, దీనిని క్రెడిట్ రికార్డ్లో ధృవీకరించవచ్చు.
ఫలితాలను పొందండి
Section titled “ఫలితాలను పొందండి”పని పూర్తయిన తర్వాత:
GET /api/v1/artifacts?job_id={job_id}పని ఇంకా నడుస్తున్నప్పుడు ఫలిత జాబితా ఖాళీగా ఉంది.