Skip to main content
POST
/
v1
/
projects
/
{project_id}
/
parse
/
upload-result
Upload Parse Result
curl --request POST \
  --url https://api.example.com/v1/projects/{project_id}/parse/upload-result \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>' \
  --data '
{
  "content": {
    "chunks": [
      {
        "content": "<string>",
        "blocks": [
          {
            "type": "<string>",
            "content": "<string>",
            "bbox": {
              "left": 123,
              "top": 123,
              "width": 123,
              "height": 123
            },
            "confidence": 123,
            "page_number": 0
          }
        ]
      }
    ]
  },
  "source_document_id": "<string>",
  "engine": "<string>",
  "parse_metadata": {
    "source_id": "<string>",
    "filename": "<string>",
    "pages_processed": 123
  },
  "object": "parse_result",
  "parameters": {},
  "error": "<string>",
  "processing_time_ms": 123
}
'
{
  "content": {
    "chunks": [
      {
        "content": "<string>",
        "blocks": [
          {
            "type": "<string>",
            "content": "<string>",
            "bbox": {
              "left": 123,
              "top": 123,
              "width": 123,
              "height": 123
            },
            "confidence": 123,
            "page_number": 0
          }
        ]
      }
    ]
  },
  "source_document_id": "<string>",
  "engine": "<string>",
  "parse_metadata": {
    "source_id": "<string>",
    "filename": "<string>",
    "pages_processed": 123
  },
  "id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "parse_result",
  "parameters": {},
  "error": "<string>",
  "processing_time_ms": 123
}

Authorizations

x-api-key
string
header
required

API key for authentication

x-selected-account-id
string
header
required

Selected Account ID

Path Parameters

project_id
string
required

Body

application/json

Entity for custom parse results.

content
ParseResultContent · object
required

Array of chunks from parsing

source_document_id
string
required

Source document ID that was parsed

engine
string
required

Engine used for parsing

parse_metadata
ParseResultMetadata · object
required

Parse result metadata

object
string
default:parse_result
Allowed value: "parse_result"
parameters
Parameters · object

Parameters used during parsing

error
string | null

Error message if parsing had issues

processing_time_ms
integer | null

Processing time in milliseconds

Response

Successful Response

Parse result response model representing a completed parse operation.

content
ParseResultContent · object
required

Array of chunks from parsing

source_document_id
string
required

Source document ID that was parsed

engine
string
required

Engine used for parsing

parse_metadata
ParseResultMetadata · object
required

Parse result metadata

id
string
required

ID of the entity

project_id
string
required

ID of the project

created_at
string<date-time>
required

When the parse result was created

object
string
default:parse_result
Allowed value: "parse_result"
parameters
Parameters · object

Parameters used during parsing

error
string | null

Error message if parsing had issues

processing_time_ms
integer | null

Processing time in milliseconds