---
title: "Index a site"
method: POST
path: "/api/v1/index"
tags: ["Indexing"]
---

# Index a site

`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

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

## Request body

- object
  - `url` string, uri, required
  - `focus` string: 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).
  - `maxCapabilities` integer: 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.
  - `public` boolean: Publish the capabilities to the public index.

## Response `202`

The job

- Object

## Other responses

- `400`: An error
- `401`: Missing or invalid credentials. The WWW-Authenticate header names the protected-resource metadata.
- `402`: An error
- `404`: An error
- `429`: An error

---

[API](https://skmtc.dev/unbrowse/apis/unbrowse-api.md) · [All operations](https://skmtc.dev/unbrowse/apis/unbrowse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/unbrowse/apis/unbrowse-api/revisions/f49034a1fbff?raw)