V2
Parse

Upload File Multipart

Changed on

Upload and parse a file using multipart/form-data.

Send the file as a file field and parsing configuration as a configuration JSON string field.

The job runs asynchronously. Poll GET /parse/{job_id} with expand to retrieve results.

post/api/v2/parse/upload

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique parse job identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this job belongs to

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

error_messagestring nullable

Error details when status is FAILED

namestring nullable

Optional display name for this parse job

tierstring nullable

Parsing tier used for this job

Example response

{
  "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "Q4 Financial Report",
  "tier": "fast"
}

Changes

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status