Sign in
search-tools

Test Search Tool

Changed on

Test a configured or stored instance with one search or one fetch.

Takes query for a search instance or url for a fetch instance, and answers as POST /search-tools/test does. builtin_fetch has no test yet, and answers a 400.

post/api/v1/search-tools/{name}/test

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

namestring required

Request body

querystring nullable

For a search instance: the query to run.

urlstring nullable

For a fetch instance: the page to fetch.

Response

Successful Response

charactersinteger nullable

For a fetch that worked: how many characters of page text came back.

errorstring nullable

When not ok, the error's tag: timeout, network, http_error, invalid_response, or the provider's own.

hitsinteger nullable

For a search that worked: how many hits came back.

okboolean required

Whether the provider answered the call without an error.

Changes