Referência da API: pesquisa

O endpoint de busca faz uma pesquisa global (semântica) no conteúdo do ambiente. Você pode testá-lo no seu próprio espaço de trabalho com um teste grátis.

Pesquisa global nas funções, processos, elementos, documentação, versões e comentários do ambiente

O limite de requisições é aplicado por ambiente; uma resposta 429 inclui a mensagem compartilhada ({“message”: “Too many search requests, please slow down.”}).

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

Autenticação: Chave de API vinculada ao ambiente · escopo read

Parâmetros:

Corpo da solicitação:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}

Resposta (200):

Resultados da pesquisa (ocorrências, contagens, total, sugestões)

{
	"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"
	]
}

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 429 Limite de requisições atingido: consulte o limite documentado para o endpoint