ఫైల్లను అప్లోడ్ చేయండి
అప్లోడ్ చేయడానికి మూడు దశలు ఉన్నాయి: అప్లోడ్ చిరునామాను అభ్యర్థించడం, ఫైల్ను పంపడం, డాక్యుమెంట్ను ధృవీకరించడం. ఒకసారి రాసిన అప్లోడ్ చిరునామా 1 గంట వరకు చెల్లుబాటు అవుతుంది.
1. అప్లోడ్ చిరునామాను అభ్యర్థించండి
Section titled “1. అప్లోడ్ చిరునామాను అభ్యర్థించండి”POST /api/v1/upload/presignX-API-Key: sk_your_keyContent-Type: application/json{ "filename": "report.docx", "file_size": 45678}| క్షేత్రం | రకం | అవసరం | వివరణ |
|---|---|---|---|
filename | string | ✅ | ఫైల్ పేరు; సర్వర్ విస్తరణ నుండి ఫైల్ రకాన్ని గుర్తిస్తుంది |
file_size | పూర్ణాంకం | ✅ | బైట్లలో ఖచ్చితమైన పరిమాణం, 0 కంటే ఎక్కువ |
mime_type | string | — | ఐచ్ఛికం; సర్వర్ దీన్ని ఉపయోగించదు |
ప్రతిస్పందన:
{ "document_id": "4q8mx2q9z1k7p6ra", "upload_url": "https://upload.example/...", "upload_headers": { "Content-Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "If-None-Match": "*" }, "finalize_token": "short_lived_token", "expires_in": 3600}2. ఫైల్ను పంపండి
Section titled “2. ఫైల్ను పంపండి”PUTని upload_urlకు పంపండి, దీని శరీరంగా మూల ఫైల్ బైట్లను ఉపయోగించండి మరియు upload_headersలోని ప్రతి హెడర్ను ఇవ్వబడిన విధంగానే పంపండి.
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous responsecurl --fail-with-body -X PUT "$UPLOAD_URL" \ -H "Content-Type: $UPLOAD_CONTENT_TYPE" \ -H "If-None-Match: *" \ --upload-file "report.docx"ఈ దశలో OmniDoc API కీని పంపవద్దు. చిరునామా గడువు ముగిసినట్లయితే లేదా బదిలీ విఫలమైతే, కొత్తది అభ్యర్థించండి.
3. పత్రాన్ని ధృవీకరించండి
Section titled “3. పత్రాన్ని ధృవీకరించండి”POST /api/v1/upload/finalizeX-API-Key: sk_your_keyContent-Type: application/json{"finalize_token":"short_lived_token"}విజయవంతమైన సందర్భంలో డాక్యుమెంట్ను తిరిగి ఇస్తారు:
{ "document": { "id": "4q8mx2q9z1k7p6ra", "basename": "report.docx", "file_size": 45678, "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "created_at": "2026-10-01T12:00:00Z" }}ధృవీకరణ తర్వాత మాత్రమే పత్రం ఫైల్ లైబ్రరీలోకి ప్రవేశిస్తుంది మరియు ఉపయోగించడానికి అందుబాటులోకి వస్తుంది.
ఫైల్ పేర్లు
Section titled “ఫైల్ పేర్లు”filename కేవలం ప్రదర్శన కోసం మాత్రమే; దీనిని పథకంగా లేదా ప్రత్యేక గుర్తింపు సంఖ్యగా ఉపయోగించవద్దు. అనుమతి లేని అక్షరాలను సర్వర్ భర్తీ చేసి, పొడవైన పేర్లకు సురక్షితమైన డౌన్లోడ్ పేరును రూపొందిస్తుంది.
తప్పులు
Section titled “తప్పులు”| స్థితి | కారణం |
|---|---|
400 | అమాన్యమైన ఫైల్ పేరు లేదా పరిమాణం, లేదా అప్లోడ్ చేసిన పరిమాణం అభ్యర్థించిన దానికి భిన్నంగా ఉంది |
401 | ప్రమాణ పత్రం లేదా finalize_token చెల్లనిది లేదా గడువు ముగిసినది |
403 | finalize_token మరొక ఖాతాకు చెందుతుంది |
410 | అప్లోడ్ చేసిన ఫైల్ కనుగొనబడలేదు (బదిలీ అసంపూర్ణం లేదా చిరునామా గడువు ముగిసింది); కొత్త చిరునామాను అభ్యర్థించండి |
413 | ప్రతి ఫైల్ పరిమాణ పరిమితిని మించిపోయింది |
415 | సమర్థించబడని ఫార్మాట్ లేదా కంటెంట్ ఎక్స్టెన్షన్తో సరిపోలడం లేదు |
422 | Office ఫైల్ దెబ్బతిన్నది లేదా నిర్మాణపరంగా సురక్షితం కాదు |
429 | అనేక అప్లోడ్లు |
503 | అప్లోడ్ సర్వీస్ తాత్కాలికంగా అందుబాటులో లేదు; తర్వాత మళ్లీ ప్రయత్నించండి |