For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The type of sorting that should be applied to the search results, relevancy is the default and should be
Allowed values:
directionenumOptional
The direction of the sorting, ascending or descending
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
Response
Successful Response
offsetinteger
The offset of the first function in the search results for pagination
limitinteger
The limit of the search results for pagination
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
functionslist of objects
The list of functions that match the search criteria