documentsList documents currently existing in knowledge base

List documents currently existing in knowledge base

curl -X GET "https://api.prd.rad.security/tenants/example_string/knowledge_base/documents?limit=50&offset=0&filter=example_string" \
  -H "Content-Type: application/json"
{
  "current_offset": 42,
  "has_more": true,
  "total_count": 10,
  "entries": [
    {
      "id": "example_string",
      "tenant_id": "example_string",
      "account_id": "example_string",
      "file_name": "John Doe",
      "status": "example_string",
      "collections": [
        "example_string"
      ],
      "created_at": "2024-12-25T10:00:00Z",
      "uploaded_at": "2024-12-25T10:00:00Z",
      "updated_at": "2024-12-25T10:00:00Z"
    }
  ]
}
GET
/tenants/{tenant_id}/knowledge_base/documents
GET
Base URLstring

Target server for requests. Edit to use your own host.

query
limitinteger

Number of records to return

Min: 1
query
offsetinteger

Requested record offset

Min: 0
query
filterstring

The filter query for the collection, in the form of 'key1:value1,key1:value2,key2:value3'

Request Preview
Response

Response will appear here after sending the request

Path Parameters

Query Parameters

limitinteger

Number of records to return

offsetinteger

Requested record offset

filterstring

The filter query for the collection, in the form of 'key1:value1,key1:value2,key2:value3'

Responses

current_offsetinteger
Required

The offset of the currently requested record set

has_moreboolean
Required

If there are more records available

total_countinteger
Required

The total number of records that match the criteria

entriesarray
Required