COcontextualai
/datastores/{id}/documents

Get Parse Results

Changed on

Get the parse results that are generated during ingestion for a given document. Retrieving parse results for existing documents ingested before the release of this endpoint is not supported and will return a 404 error.

get/datastores/{datastore_id}/documents/{document_id}/parse

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/datastores/{datastore_id}/documents/{document_id}/parse
  • Auth
    HTTP bearer

Path parameters

datastore_idstring uuid required

Datastore ID of the datastore from which to retrieve the document

document_idstring uuid required

Document ID of the document to retrieve details for

Query parameters

output_typesParseOutputFormat[]

The desired output format(s) of the parsed file. Must be markdown-document, markdown-per-page, and/or blocks-per-page. Specify multiple values to get multiple formats in the response. markdown-document parses the whole document into a single concatenated markdown output. markdown-per-page provides markdown output per page. blocks-per-page provides a structured JSON representation of the content blocks on each page, sorted by reading order.

Response

Successful Response

file_namestring required

The name of the file that was uploaded for parsing

status'pending' | 'processing' | 'retrying' | 'completed' | 'failed' | 'cancelled' required
markdown_documentstring

The parsed, structured Markdown of the input file. Only present if markdown-document was among the requested output types.

Changes