REregdoor
knowledge

Retrieve Documents

Retrieve documents from the knowledge base using semantic or hybrid search

get/api/companies/{company_uuid}/retrieve

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

company_uuidstring uuid required

Query parameters

querystring
limitinteger nullable

Max number of document chunks to retrieve

integer
OR
integer[]
semantic_searchboolean nullable

Activate semantic search

full_text_searchboolean nullable

Activate full text search

string
OR
string[]
published_fromstring date-time nullable

Filter by publication date from (inclusive). Accepts ISO 8601 format, treated as UTC. Examples: 2024-01-01T00:00:00Z, 2024-01-01T00:00:00+00:00, or 2024-01-01T00:00:00

published_tostring date-time nullable

Filter by publication date to (inclusive). Accepts ISO 8601 format, treated as UTC. Examples: 2024-06-30T23:59:59Z, 2024-06-30T23:59:59+00:00, or 2024-06-30T23:59:59

string uuid
OR
string[]
string uuid
OR
string[]
string uuid
OR
string[]
string uuid
OR
string[]
consultation_rolestring nullable

Filter by consultation_role in the content info field

string uuid
OR
string[]
string uuid
OR
string[]
string uuid
OR
string[]
languagestring

Language of the search query and documents

Headers

X-User-Emailstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.