API Reference
API Reference

Document Extraction To Workspace

post
https://{endpoint}/v2/workspace
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Headers
string
required

Workspace ID

string

File name to be used if save to workspace is enabled. If not provided, the file will be listed as "Untitled" in the workspace if there is no way todetermine its name

string

URL of the image to be processed in jpg or png format, or URL of a pdf file

string
enum
Defaults to raw

Encoding of the request body, allowed raw or base64

Allowed:
number
Defaults to 150

DPI of the uploaded pdf file

string
enum

OCR Engine

Allowed:
string

original file name

string
enum
Defaults to true

Flag for auto adjusting image size for better extraction result, it will take a longer for extraction if enabled

Allowed:
string
enum
Defaults to false

Flag for returning OCR result in the response.

Allowed:
string
enum
Defaults to per-page

Processing mode: If set, it will override the processing mode setting on the specified extractor. Please note that the per-file mode is not supported by all models. When it is not applicable, only the first page of the file will be processed.

Allowed:
string
length ≤ 2048

Pass extra data as ASCII string to FormX. For structured data, consider represent it as JSON. For string containing non-ASCII string, consider encode it with base64

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago