List Chunks

GET 
/api/chunks/

List chunks.

Request

Query Parameters

collection any

Limit to chunks associated with this collection

document_id any

Limit to chunks associated with this document

page any
perPage any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

oneOf

TextChunk

id Idrequired

document_id Document Idrequired

kind Kind

Default value: text

text Textrequired

raw Rawrequired

start_char_idx

object

Start char index of the chunk.

anyOf

MOD1

integer

end_char_idx

object

End char index of the chunk.

anyOf

MOD1

integer

ImageChunk

id Idrequired

document_id Document Idrequired

kind Kind

Default value: image

image

object

required

Image of the node.

anyOf

MOD1

string

image_mimetype

object

required

Mimetype of the image.

anyOf

MOD1

string

image_path

object

required

Path of the image.

anyOf

MOD1

string

image_url

object

required

URL of the image.

anyOf

MOD1

string

• ]

Example (from schema)

[
  {},
  {}
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Messagerequired

type Error Typerequired

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...