Knowledge Base

Search nodes by name

Searches the knowledge base by node name and returns the matching nodes the caller can access. An empty q returns an empty list.

get/org/kb/find

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Query parameters

qstring

The search text (matched against node names). Empty returns no results.

limitinteger

Page size, 1–50 (default 50). Values above 50 are capped at 50.

offsetinteger

Number of rows to skip.

type'folder' | 'content'

Restrict to folders or documents.

status'pending' | 'processing' | 'complete' | 'failed'

Restrict document nodes by ingestion status. Ignored when type=folder (folders have no ingestion status).

role'editor' | 'viewer'

Restrict to nodes on which the caller holds this role. Applies only to permission-scoped callers; it is ignored (results are not narrowed) for org-admin callers, including an unscoped API key (which has full access).

sort_by'name' | 'updated_at' | 'created_at' | 'type' | 'status' | 'role'

Field to sort by. role ordering applies only to permission-scoped callers; for org-admin callers (including an unscoped API key) it falls back to the default folders-first, name order.

sort_order'asc' | 'desc'

Sort direction.

tag_idsstring

Comma-separated tag ids; restrict to nodes carrying any of them.

Response

The matching nodes.

totalinteger required
limitinteger required
offsetinteger required

Changes

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