On This Page
> resources > docs > api > API Reference: Search

API Reference: Search

The search endpoint performs a global (semantic) search across the tenant’s content.

Global search across the tenant’s roles, processes, elements, documentation, versions and comments

Rate-limited per tenant; a 429 response carries the shared message body ({“message”: “Too many search requests, please slow down.”}).

Endpoint: POST /v1/tenant/{tenantId}/search

Auth: Tenant-scoped API key · read scope

Parameters:

Name Type Location Required Description
tenantId string path Yes Format: uuid

Request Body:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Field Type Required Description
query string Yes Search query
Max length: 1000
mode semantic | exact | hybrid No semantic = embeddings, exact = literal, hybrid = both
Allowed values: semantic, exact, hybrid
Default: hybrid
categories role | process | element | documentation | version | comment[] No Restrict results to these categories
processId string No Restrict results to a single process
Format: uuid
k integer No Number of results to return
Default: 20
Min: 1
Max: 50

Response (200):

Search results (hits, counts, total, suggestions)

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}
Field Type Required Description
hits object[] Yes
counts object Yes
total number Yes
suggestions string[] Yes

Errors:

  • 401 Missing, invalid, disabled or expired API key
  • 429 Rate limited: see the endpoint’s documented rate limit

Related Documentation