DocumentListResponse

DocumentListResponse
DocumentListResponse

List of documents.

JSON Example
{
    "object": "string",
    "has_more": false,
    "num_objects": 0,
    "data": [
        {
            "origin_name": "string",
            "origin_ref": "string",
            "id": "string",
            "object": "string",
            "knowledge_base_id": "string",
            "index_id": "string",
            "data_source_id": "string",
            "created_at": 0,
            "last_embedded_at": 0,
            "last_indexed_by_id": "string",
            "size_bytes": 0,
            "hash_sha256": "string",
            "reindexing_needed": false
        }
    ],
    "first_id": "string",
    "last_id": "string"
}
string
object
Optional
Constraints: default: list

Object type, which is always list.

boolean
has_more
Optional

True, if the server may have more objects than returned in the response.

integer
num_objects
Required

Total number of objects that match the request. Note that this field is populated only if requested by the user (see set_num_objects request parameter).

array of Document
data
Required

data

string As uuid As uuid
first_id
Required

ID of the first element in the list (if any)

string As uuid As uuid
last_id
Required

ID of the last element in the list (if any)

Returned By