type required | string Type
@@ -413,7 +413,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Delete One Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Delete One path Parametersid required | string ID
@@ -433,7 +433,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Patch Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Patch path Parametersid required | string ID
@@ -445,7 +445,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Copy One Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Copy One path Parametersid required | string ID
@@ -497,7 +497,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"data": [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ], "page": 0, "query": {"createTimeAfter": 0, "createTimeBefore": 0, "text": "string", "type": "file", "updateTimeAfter": 0, "updateTimeBefore": 0 }, "size": 0, "totalElements": 0, "totalPages": 0 } Move One Response samples Content typeapplication/json {"data": [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ], "page": 0, "query": {"createTimeAfter": 0, "createTimeBefore": 0, "text": "string", "type": "file", "updateTimeAfter": 0, "updateTimeBefore": 0 }, "size": 0, "totalElements": 0, "totalPages": 0 } Move One path Parametersid required | string ID
@@ -519,7 +519,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Request samples Content typeapplication/json Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Download Original Request samples Content typeapplication/json Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Download Original path Parametersid required | string ID
@@ -553,7 +553,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
/v2/files/{id}/patch_from_s3 Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Get Path /v2/files/{id}/patch_from_s3 Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Get Path path Parametersid required | string ID
@@ -563,7 +563,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ] Download Preview Response samples Content typeapplication/json [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ] Download Preview path Parametersid required | string ID
@@ -681,7 +681,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Grant Group Permission Response samples Content typeapplication/json {"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } Grant Group Permission path Parametersid required | string ID
@@ -711,7 +711,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ] Move Many Response samples Content typeapplication/json [{"createTime": "string", "id": "string", "isShared": true, "name": "string", "parentId": "string", "permission": "string", "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 }, "type": "string", "updateTime": "string", "workspaceId": "string" } ] Move Many Request Body schema: application/jsonrequired Body
@@ -891,7 +891,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"isAvailable": true, "isOutdated": true, "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 } } Download OCR Response samples Content typeapplication/json {"isAvailable": true, "isOutdated": true, "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 } } Download OCR path Parametersid required | string ID
@@ -1039,7 +1039,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"isAvailable": true, "isOutdated": true, "metadata": {"extension": "string", "height": 0, "width": 0, }, "snapshot": {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 } } Download Tile Response samples Content typeapplication/json {"isAvailable": true, "isOutdated": true, "metadata": {"extension": "string", "height": 0, "width": 0, }, "snapshot": {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 } } Download Tile path Parametersid required | string ID
@@ -1155,7 +1155,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Not Found
Response samples Content typeapplication/json {"data": [{"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 } ], "page": 0, "size": 0, "totalElements": 0, "totalPages": 0 } Patch Response samples Content typeapplication/json {"data": [{"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 } ], "page": 0, "size": 0, "totalElements": 0, "totalPages": 0 } Patch path Parametersid required | string ID
@@ -1163,13 +1163,13 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA"> API Key
|
Request Body schema: application/jsonrequired | | fields | | | | | | | object (client.PipelineRunOptions) | | | | | | | status | | taskId | | | | | |
Responses |
Request samples Content typeapplication/json Copy Expand all Collapse all {"entities": {"bucket": "string", "key": "string", "size": 0, }, "mosaic": {"bucket": "string", "key": "string", "size": 0, }, "ocr": {"bucket": "string", "key": "string", "size": 0, }, "options": {"bucket": "string", "key": "string", "payload": {"property1": "string", "property2": "string" }, "pipelineId": "string", "snapshotId": "string", "taskId": "string" }, "original": {"bucket": "string", "key": "string", "size": 0, }, "preview": {"bucket": "string", "key": "string", "size": 0, }, "segmentation": {"bucket": "string", "key": "string", "size": 0, }, "status": "string", "taskId": "string", "text": {"bucket": "string", "key": "string", "size": 0, }, "thumbnail": {"bucket": "string", "key": "string", "size": 0, } } Response samples Content typeapplication/json Copy Expand all Collapse all {"createTime": "string", "entities": {"extension": "string", "size": 0, }, "id": "string", "isActive": true, "language": "string", "mosaic": {"extension": "string", "size": 0, }, "ocr": {"extension": "string", "size": 0, }, "original": {"extension": "string", "size": 0, }, "preview": {"extension": "string", "size": 0, }, "segmentation": {"extension": "string", "size": 0, }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"extension": "string", "size": 0, }, "thumbnail": {"extension": "string", "size": 0, }, "updateTime": "string", "version": 0 } Activate Request samples Content typeapplication/json Copy Expand all Collapse all {"entities": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "mosaic": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "ocr": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "options": {"bucket": "string", "key": "string", "payload": {"property1": "string", "property2": "string" }, "pipelineId": "string", "snapshotId": "string", "taskId": "string" }, "original": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "preview": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "segmentation": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "status": "string", "taskId": "string", "text": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 }, "thumbnail": {"bucket": "string", "document": {"pages": {"count": 0, "extension": "string" }, }, "key": "string", "size": 0 } } Response samples Content typeapplication/json Copy Expand all Collapse all {"createTime": "string", "entities": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "id": "string", "isActive": true, "language": "string", "mosaic": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "ocr": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "original": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "preview": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "segmentation": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "status": "string", "task": {"id": "string", "isPending": true }, "text": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "thumbnail": {"document": {"pages": {"count": 0, "extension": "string" }, }, "extension": "string", "size": 0 }, "updateTime": "string", "version": 0 } Activate path Parametersid required | string ID
@@ -1395,7 +1395,7 @@
" class="sc-eeDSqt sc-eBMFzZ bSgSrX cWARBq sc-dCFGXG gKOXES"> Internal Server Error
patch/workspaces/{id}/update_name/v2/workspaces/{id}/update_name Request samples Content typeapplication/json Response samples Content typeapplication/json Copy Expand all Collapse all {"createTime": "string", "id": "string", "image": "string", "name": "string", "organization": {"createTime": "string", "id": "string", "image": "string", "name": "string", "permission": "string", "updateTime": "string" }, "permission": "string", "rootId": "string", "storageCapacity": 0, "updateTime": "string" }
|
|
|
|
|
|
|
|
|
|
|