API Reference
Start typing to search…

Standardize Documents V1

post https://app.docupanda.io/standardize/batch

Standardize a batch of one or more documents all at once, either by passing a list of Document IDs or by passing a dataset name. Use the forceRecompute flag to optionally reprocess documents that have already been standardized. We recommend users to migrate to the improved V2 endpoint.

Advanced: You can specify a standardization mode to control how the AI sees the document. The options are:

  1. default - Automatically determine the best mode based on the document content.
  2. sectionBased - Represent the document as a list of sections (paragraphs, tables, images, etc.), the same ones you see in the document result field.
  3. spatial - Represent text in the document according to its spatial layout.
Body Params
string
required

Unique identifier of the schema to be used for standardization.

documentIds
array of strings
required

List of document IDs to be standardized, up to 100 per batch.

Document IDs*
boolean

Whether to recompute standardizations for documents that have already been standardized.

string

Guidelines to apply to the schema when standardizing. If this is provided, it will override the schema guidelines.

string

Advanced Feature
Choose the standardization mode. For most use-case, the default mode is recommended. If you are getting inadequate results, it can be a good idea to try the other modes.

Responses

Response body
object
string
required

Unique identifier of the standardization job.

string
required

Current status of the standardization job.

processing completed error

date-time
required

Timestamp of the last update to the job.

integer
required

Number of documents this job will effect. Documents already standardized from previous runs will not be counted.

integer
required

Number of pages this job will effect. Pages already standardized from previous runs will not be counted.

standardizationJobIds
array of strings

List of individual standardization job IDs that were run in this batch job.

Standardization Job IDs
standardizationIds
array of strings

List of individual standardization IDs that were created in this batch job.

Standardization IDs
string

Details of the status of the job.

Updated 3 days ago

Did this page help you?
Language
Credentials

Updated 3 days ago

Did this page help you?