Search Entities | Scout | Documentation

Search for entities with document content using hybrid search.

Thin handler - delegates to PulseSearch domain API.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

querystringRequired

Search query text

entity_idslist of strings or nullOptional

Specific entity IDs to search within

entity_typeslist of strings or nullOptional

Entity types to search (file, note, etc)

modeenumOptionalDefaults to hybrid

Search mode

Allowed values:

return_formatenumOptionalDefaults to chunks

What to return - chunks, entity info, or full text

Allowed values:

limitintegerOptional>=1<=100Defaults to 20

Max results

similarity_thresholddoubleOptional>=0<=1Defaults to 0.5

Minimum similarity score

Successful Response

1	import requests
2
3	url = "https://api-prod.scoutos.com/pulse/search/entities"
4
5	payload = { "query": "string" }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())