Skip to main content
GET
Search Knowledge Base Documents

Authorizations

X-API-Key
string
header
required

Path Parameters

knowledge_base_id
string
required

Query Parameters

query
string
required

File name search query

prefix
string | null

Folder prefix filter

limit
integer
default:25

Max results

Required range: 1 <= x <= 100

Response

Successful Response

id
string<uuid>
required
summary
string | null
required
status
enum<string>
required
Available options:
trained,
training,
error,
uploaded,
folder,
outdated
error
Error · object | null
required
updated_at
string<date-time>
required
created_at
string<date-time>
required
size
integer
required
short_summary
string | null
doc_type
string | null
source_type
string | null
source_external_id
string | null
source_metadata
Source Metadata · object | null
content_type
string | null
has_conversion
boolean | null
doc_metadata
Doc Metadata · object | null
name
string | null
prefix
string | null
uri
string | null
file_id
string<uuid> | null
run_id
string<uuid> | null
dismissed
boolean | null
warnings
any[] | null
needs_reingestion
boolean | null