Lewati ke konten

Unggah file

Proses unggah terdiri dari tiga langkah: meminta alamat unggah, mengirim file, dan mengonfirmasi dokumen. Alamat unggah hanya dapat ditulis sekali dan berlaku hingga 1 jam.

POST /api/v1/upload/presign
X-API-Key: sk_your_key
Content-Type: application/json
{
"filename": "report.docx",
"file_size": 45678
}
BidangTipeDiperlukanDeskripsi
filenamestring✅Nama file; server menentukan jenis file berdasarkan ekstensi
file_sizebilangan bulat✅Ukuran tepat dalam byte, lebih besar dari 0
mime_typestring—Opsional; server tidak menggunakannya

Respons:

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

Kirim PUT ke upload_url dengan byte file mentah sebagai isi pesan, dan kirimkan setiap header dalam upload_headers persis seperti yang diberikan.

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"

Jangan kirimkan kunci API OmniDoc Anda pada langkah ini. Jika alamat kedaluwarsa atau transfer gagal, mintalah yang baru.

POST /api/v1/upload/finalize
X-API-Key: sk_your_key
Content-Type: application/json
{"finalize_token":"short_lived_token"}

Jika berhasil, dokumen akan dikembalikan:

{
"document": {
"id": "4q8mx2q9z1k7p6ra",
"basename": "report.docx",
"file_size": 45678,
"mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"created_at": "2026-10-01T12:00:00Z"
}
}

Hanya setelah dikonfirmasi, dokumen tersebut masuk ke perpustakaan file dan dapat digunakan untuk pekerjaan.

filename hanya untuk tampilan; jangan gunakan sebagai jalur atau pengidentifikasi unik. Server mengganti karakter ilegal dan membuat nama unduhan yang aman untuk nama yang terlalu panjang.

StatusPenyebab
400Nama atau ukuran file tidak valid, atau ukuran yang diunggah berbeda dari yang diminta
401Kredensial atau finalize_token tidak valid atau kedaluwarsa
403finalize_token milik akun lain
410File yang diunggah tidak ditemukan (transfer belum selesai atau alamat telah kedaluwarsa); minta alamat baru
413Melebihi batas ukuran per file
415Format tidak didukung, atau konten tidak sesuai dengan ekstensi
422File Office rusak atau tidak aman secara struktural
429Terlalu banyak unggahan
503Layanan unggah sementara tidak tersedia; coba lagi nanti