Sites

Call one of a site's tools

post/api/v1/sites/{host}/call/{tool}

Request

  • Base URL: https://unbrowse.ai
  • URL: https://unbrowse.ai/api/v1/sites/{host}/call/{tool}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://unbrowse.ai/authorize, token URL https://unbrowse.ai/oauth/token, scopes: unbrowse)
    • HTTP bearer

Path parameters

hoststring required
toolstring required

Query parameters

deadlineMsinteger

Same as the x-unbrowse-deadline-ms header (the header wins).

Headers

x-unbrowse-deadline-msinteger

Answer within this many ms (clamped to 5,000–300,000; default 60,000). Past it the answer is 504 run_timeout; the run keeps going.

Request body

object required

The tool's inputs (see the site's OpenAPI spec). deadlineMs here bounds the call like the header, unless the tool takes an input of that name.

Response

The tool's result

Object required

Changes

No recorded changes to this operation across all 1 revision of this API.