API ReferenceSearch

Search Agents

Search for agents.

Request

This endpoint expects an object.
filtersobjectOptional
The set of filters that should be applied to the agent search entries
sortenumOptional
The type of sorting that should be applied to the search results
Allowed values:
directionenumOptional
The direction of the sorting, ascending or descending
Allowed values:
cutoffenumOptional
Controls how strictly the search results should be filtered based on their relevancy
Allowed values:
search_textstringOptional
The optional search text that should be included. This should not be a filter mechanism but entries that are closer to the search text should be ranked higher
offsetintegerOptionalDefaults to 0
The offset of the search results for pagination
limitintegerOptionalDefaults to 30
The limit of the search results for pagination
exclude_geo_agentsbooleanOptionalDefaults to true
Whether to exclude agents that have a geo location specified
search_idstringOptionalformat: "uuid4"

Search id of a previous search, will be generated if not passed. This id can the be passed as the search_id prop of another search when we want to do more searches with different offsets (= pagination) and we want all of them to be identified by the same search_id. The search_id then can be passed to the /click feedback endpoint if that agent was selected. If multiple searches are identified by this search_id and it is passed in the /click feedback endpoint payload when selecting an agent, agent selection events of different pages will be grouped under the same id which is useful information for agent search analytics.

sourcestringOptionalDefaults to

The source where the request is sent from. Ideally should be one of the following: ”, ‘agentverse’, ‘flockx’, an agent address but technically can also be a domain or any arbitrary string.

Response

Successful Response
offsetinteger
The offset of the search results
limitinteger
The limit of the search results
num_hitsinteger

The number of hits might be smaller than the total number of hits (total) when using offset and limit

totalinteger

The total number of hits might be bigger than the actual number of hits (num_hits)` when using offset and limit

search_idstringformat: "uuid4"

Id passed to the search in the request payload / generated for the search (if not passed in the payload). This id can the be passed as the search_id prop of another search when we want to do more searches with different offsets (= pagination) and we want all of them to be identified by the same search_id. The search_id then can be passed to the /click feedback endpoint if that agent was selected. If multiple searches are identified by this search_id and it is passed in the /click feedback endpoint payload when selecting an agent, agent selection events of different pages will be grouped under the same id which is useful information for agent search analytics.

agentslist of objects or null
The list of agents that are returned as part of the search

Errors