Құжаттар мен файлдарға арналған құралдар
OmniDoc синхронды файл құралдарын және бақыланатын асинхронды құжат операцияларын ұсынады. Алдымен мүмкіндіктердің нүктелерін шақырыңыз; клиентте қолдау көрсетілетін форматтарды немесе шектеулерді тұрақты кодтауға болмайды.
Мүмкіндіктерді анықтау
Section titled “Мүмкіндіктерді анықтау”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesБұлар қазіргі уақытта ашық операцияларды, олардың енгізу форматтарын, төлем және техникалық шектеулерді қайтарады. unavailable астында көрсетілген мүмкіндіктерді жасауға болмайды.
Асинхронды құжаттық операциялар
Section titled “Асинхронды құжаттық операциялар”POST /api/v1/document-operationsIdempotency-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=25POST /api/v1/document-operations/{operation_id}/cancelАяқталғаннан кейін жауаптың output_document_id файлдық кітапханаға немесе басқа тапсырмаға жіберуге болады, ал credit_operation_id есеп айырысу жазбасын береді.
PDF құралдары
Section titled “PDF құралдары”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressБіріктіру мысалы:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Бөлу мысалы:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Кескін құралдары
Section titled “Кескін құралдары”POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Құралдар тек ағымдағы тіркелгіге тиесілі және типі сәйкес келетін құжаттарды ғана қабылдайды. Екілік жауаптарды ағын ретінде өңдеңіз және файл атауы мен типін жауаптың басынан алыңыз.