Retrieve the most relevant chunks (one query unit)
POST/v1/knowledge_bases/:kb_id/search
One successful search is one query unit, including a successful search with zero results. Refused or failed searches are not charged. The query text is never stored or logged. With Idempotency-Key, a replay returns the same hits (re-checked against current visibility, so deleted content drops out) and is not charged again.
Access: API key scope knowledge:read or knowledge:write; portal users: any member of the organization; the knowledge base in the path must be on the key's access list.
Request
Responses
- 200
- 402
- 403
- 404
- 409
- 422
- 429
- 503
OK
trial_exhausted, insufficient_credits, credit_limit_exceeded, payg_spend_cap_exceeded, payment_suspended — details.price_card_url always set. After the free trial, knowledge bases are billed pay-as-you-go for every organization (from the prepaid wallet or on the postpaid invoice); no plan or commitment covers them.
scope_missing, kb_not_in_allowlist, role_insufficient, actor_not_permitted, tenant_suspended, module_disabled (knowledge bases switched off on the platform: an operation that creates data or starts processing, for an organization that still has knowledge bases), web_sources_disabled, domain_blocked, domain_not_verified (website sources)
not_found (absent or owned by another organization — identical), module_disabled
idempotency_key_conflict, idempotency_in_progress, version_conflict, duplicate_content, kb_suspended, kb_deleting, document_deleting, document_not_ready, invalid_document_state, trial_kb_frozen, resource_limit_reached, export_in_progress, source_sync_in_progress, invalid_source_state, duplicate_source
validation_failed, invalid_identifier, metadata_*, filter_invalid, query_too_long, batch_too_large, file-type codes, https_required, source_url_rejected, robots_disallowed, ai_signal_optout, attestation_required, terms_acceptance_required
rate_limited, concurrency_limited — Retry-After header set
maintenance_mode, knowledge_unavailable, retrieval_unavailable, billing_unavailable — Retry-After header set