Alpha APIKnowledge

Search Knowledge

View as Markdown

Search the discovery knowledge base (departments, people, processes, systems, problems, opportunities, KPIs) by name or alias. Returns matching entities with descriptions.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
querystringRequired
Name or alias to search for
vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

typeenumOptional
Optional entity type filter

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Search Knowledge completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error