跳转到内容

Құжаттар мен файлдарға арналған құралдар

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
}

Құралдар тек ағымдағы тіркелгіге тиесілі және типі сәйкес келетін құжаттарды ғана қабылдайды. Екілік жауаптарды ағын ретінде өңдеңіз және файл атауы мен типін жауаптың басынан алыңыз.