curl --request POST \
--url https://app.famulor.io/api/v1/knowledge-bases/{id}/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "What is the price for AX-100?"
}
'{
"data": {
"results": [
{}
],
"table_result": {}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Search knowledge or query a table
Search document excerpts and exact table values with original cells and sources. Send either query (natural-language question) or table_query (exact lookup or aggregate on one sheet). Table queries evaluate complete sheets, independent of search limits. Cached formulas are unverified; ambiguous or missing numeric values and mixed units are rejected by aggregates. Required scope: knowledge:read (keys without scope restrictions have full access).
curl --request POST \
--url https://app.famulor.io/api/v1/knowledge-bases/{id}/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "What is the price for AX-100?"
}
'{
"data": {
"results": [
{}
],
"table_result": {}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Path Parameters
Knowledge base ID.
Body
- Option 1
- Option 2
Send query or table_query. If both are present, only table_query is evaluated.
Natural-language question to search document excerpts (max 2000 characters).
1 - 2000Exact table lookup or aggregate (rows, count, sum, min, max) on one sheet; use instead of query. Take document_id, sheet and column keys from earlier search results.
Show child attributes
Show child attributes
Response
Search results with content, similarity, document reference and source (file, sheet, row, cells, indexed time and match method), or a table result with matching row count, exact decimal value as a string, unit, rows and display truncation flag.
Show child attributes
Show child attributes