v1

latestOpenAPI 3.0.32026-07-1471019.9 KB

API: Search

Search relevant references associated with the search query.

This endpoint is a scaled down version of the messaging API. It will only search and return relevant references based on the search query.

post/search

searchQuerystring text required

Content of the search query.

channelIdstring uuid required

ID of the channel on who's content should be searched.

limitinteger

A number indicating how many results should it return at most. Default is 50.

A response containing a list of references if references were identified, otherwise an empty array.

{
  "searchReferences": [
    {
      "relevanceRank": 1
    }
  ]
}