api.md

Shared

Types:

• JsonSchemaSpec

Files

Types:

• File
• FileListResponse

Methods:

• client.files.retrieve(id) -> File
• client.files.list({ ...params }) -> FileListResponse
• client.files.delete(id) -> void
• client.files.download(id) -> Response
• client.files.upload({ ...params }) -> File

Tasks

Types:

• TaskResponse
• TaskListResponse

Methods:

• client.tasks.retrieve(id) -> TaskResponse
• client.tasks.list({ ...params }) -> TaskListResponse

Events

Types:

• EventListResponse

Methods:

• client.events.list({ ...params }) -> EventListResponse

ImageOperations

Types:

• ApplyEffectResponse
• BoundingBox
• ConvertRequest
• ConvertResponse
• CoordinatesItem
• DetectDocumentsResponse
• ExtractTextRequest
• ExtractTextResponse
• ImageFromTaskResponse
• ScanResponse
• WarpRequest
• WarpResponse

Methods:

• client.imageOperations.applyEffect({ ...params }) -> ApplyEffectResponse
• client.imageOperations.convert({ ...params }) -> ConvertResponse
• client.imageOperations.detectDocuments({ ...params }) -> DetectDocumentsResponse
• client.imageOperations.extractText({ ...params }) -> ExtractTextResponse
• client.imageOperations.scan({ ...params }) -> ScanResponse
• client.imageOperations.warp({ ...params }) -> WarpResponse

PdfOperations

Types:

• DocumentFromTask
• ExtractPages
• Merge
• Render
• Split

Methods:

• client.pdfOperations.extractPages({ ...params }) -> ExtractPages
• client.pdfOperations.merge({ ...params }) -> Merge
• client.pdfOperations.render({ ...params }) -> Render
• client.pdfOperations.split({ ...params }) -> Split