Get Markdown Document Sets

GET 
/api/v8/partner/document-to-markdown-set

Get Markdown Document Sets

Request

Responses

200

A list of Markdown Document Sets.

application/json

Schema

Schema

count integerrequired

The total number of document sets.

next (string | null)

URL to the next page of results.

previous (string | null)

URL to the previous page of results.

results object[]required
The collection of markdown document sets.
Array [
id integerrequired
The unique identifier of the collection of processed documents.
document_ids integer[]
The unique identifiers of the markdown documents created from processed PDF Splitter.
status stringrequired
Possible values: [processed, in_progress, deleted, failed, started, split_in_progress]
page_breaks object[]
A list of page breaks to split a document. Each object defines what pages to use to create a new document.
Array [
page_start integerrequired
Possible values: > 0
Page start
page_end integerrequired
Possible values: > 0
Page end
]
]

Example (from schema)

{
  "count": 0,
  "results": [
    {
      "id": 0,
      "status": "processed",
      "page_breaks": [
        {
          "page_start": 0,
          "page_end": 0
        }
      ]
    }
  ]
}

Loading...