跳转到内容

Файлдарды жүктеу

Жүктеу үш қадамнан тұрады: жүктеу мекенжайын сұрау, файлды жіберу және құжатты растау. Жүктеу мекенжайы бір рет жазылады және 1 сағатқа дейін жарамды.

1. Жүктеу мекенжайын сұраңыз

Section titled “1. Жүктеу мекенжайын сұраңыз”
POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
СалалықТүріҚажетСипаттама
filenameжол✅Файл атауы; сервер файл түрін кеңейтуден анықтайды
file_sizeбүтін сан✅Байттардағы нақты өлшем, 0-ден үлкен
mime_typeжол—Міндетті емес; сервер оны пайдаланбайды

Жауап:

{
"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
}

PUT мәтінін upload_url адресіне дене ретінде шикі файл байттарымен жіберіңіз және upload_headers белгілерінің әрқайсысын берілгендей дәл көрсетіңіз.

Terminal window
# UPLOAD_URL and UPLOAD_CONTENT_TYPE come from upload_url and upload_headers["Content-Type"] in the previous response
curl --fail-with-body -X PUT "$UPLOAD_URL" \
-H "Content-Type: $UPLOAD_CONTENT_TYPE" \
-H "If-None-Match: *" \
--upload-file "report.docx"

Бұл қадамда OmniDoc API кілтін жібермеңіз. Мекенжай мерзімі өтсе немесе аударым сәтсіз болса, жаңасын сұраңыз.

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-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"
}
}

Құжат тек расталғаннан кейін ғана файлдар кітапханасына енеді және жұмыстарда пайдалануға болады.

filename тек көрсету үшін ғана арналған; оны жол немесе бірегей идентификатор ретінде пайдаланбаңыз. Сервер заңсыз таңбаларды ауыстырады және тым ұзын атаулар үшін қауіпсіз жүктеу атауын жасайды.

МәртебеСебеп
400Жарамсыз файл атауы немесе өлшемі, немесе жүктелген өлшем сұралғаннан ерекше
401Несие немесе finalize_token жарамсыз немесе мерзімі өткен
403finalize_token басқа аккаунтқа тиесілі
410Жүктелген файл табылмады (тасымалдау аяқталмаған немесе мекенжай уақыты өткен); жаңа мекенжайды сұраңыз
413Файл өлшемінің шегінен асып кетті
415Қолдаусыз формат немесе мазмұн кеңейтілімге сәйкес келмейді
422Office файлы бүлінген немесе құрылымдық тұрғыдан қауіпсіз емес
429Жүктеулер тым көп
503Жүктеу қызметі уақытша қолжетімсіз; кейінірек қайта тырыңыз