Indexing

Index a site

Explores the site in the cloud browser and compiles what it finds into capabilities. Follow the job at /api/v1/index/{jobId}.

post/api/v1/index

Request

  • Base URL: https://unbrowse.ai
  • URL: https://unbrowse.ai/api/v1/index
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://unbrowse.ai/authorize, token URL https://unbrowse.ai/oauth/token, scopes: unbrowse)
    • HTTP bearer

Request body

urlstring uri required
focusstring

What to look for, in plain words. Only sitemap page types that match it are indexed, none when it names flows (paging, page size, filters, search).

maxCapabilitiesinteger

At most this many tools in all: declared tools, sitemap page types and recorded flows together. Left out: up to 6 recorded flows plus up to 8 sitemap page types.

publicboolean

Publish the capabilities to the public index.

Response

The job

Object required

Changes

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