API overview

Use REST API v1 to complete four common tasks:

Client libraries

Library	Install
Python	`pip install bisibility`
TypeScript	`npm install @bisibility/sdk`
Go	`go get bisibility.com/sdk-go`
MCP server	`npm install @bisibility/mcp`

Start with those task guides if you are building an integration. Use the route inventory below as a reference after the first request works. The REST API is served from:

/api/v1

Hosted:

https://bisibility.com/api/v1

Self-hosted:

https://your-host.example/api/v1

Core resource routes

These core routes are handled by lib/api/router.ts. See /openapi.json for the full generated inventory.

Method	Path	Auth
`GET`	`/health`	No
`GET`	`/openapi.json`	No
`GET`	`/capabilities`	No
`GET`	`/llms.txt`	No
`GET`	`/provider-rates`	No
`GET`	`/cost-estimate`	No
`GET`	`/projects`	Yes
`POST`	`/projects`	Yes
`GET`	`/me`	Personal token
`PATCH`	`/me`	Personal token
`GET`	`/me/tokens`	Personal token
`POST`	`/me/tokens`	Personal or OAuth token
`DELETE`	`/me/tokens/{token_id}`	Personal token
`GET`	`/projects/{project_id}`	Yes
`PATCH`	`/projects/{project_id}`	Yes
`DELETE`	`/projects/{project_id}`	Yes
`GET`	`/projects/{project_id}/keywords`	Yes
`POST`	`/projects/{project_id}/keywords`	Yes
`GET`	`/keywords/{id}`	Yes
`PATCH`	`/keywords/{id}`	Yes
`DELETE`	`/keywords/{id}`	Yes
`POST`	`/keywords/bulk`	Yes
`POST`	`/keywords/{id}/checks`	Yes
`GET`	`/keywords/{id}/rank-checks`	Yes
`GET`	`/rank-checks/{check_id}`	Yes
`GET`	`/api-keys`	Yes
`POST`	`/api-keys`	Yes
`DELETE`	`/api-keys/{key_id}`	Yes
`GET`	`/projects/{project_id}/api-keys`	Yes
`POST`	`/projects/{project_id}/api-keys`	Yes
`GET`	`/projects/{project_id}/webhooks`	Yes
`POST`	`/projects/{project_id}/webhooks`	Yes
`POST`	`/cloud/import`	Migration token

Cloud import is also mounted at /api/cloud/import outside the /api/v1 base path for the in-app cloud migration handoff. The /api/v1/cloud/import path re-exports the same handler. It is not currently listed in /openapi.json. Inbound deploy hooks are also mounted outside /api/v1 at POST /api/ingest/deploy. See Deploy webhooks. Alert rules, competitors, provider connections, saved views, signals, personal access tokens, webhooks, notification preferences, and team routes have dedicated pages. Migration tokens are covered in Cloud import. PUT, OPTIONS, and other methods return 405 Method Not Allowed.

Response shapes

List routes return:

{
  "data": [],
  "meta": { "next_cursor": null }
}

Resource and mutation routes return the resource object directly. They are not wrapped in data. Discovery routes are mixed:

Route	Shape
`/health`	Raw JSON object
`/openapi.json`	Raw OpenAPI document
`/capabilities`	`{ "data": [...] }`
`/llms.txt`	Plain text

Pagination

List routes accept:

Query	Description
`limit`	Page size. Defaults to `50`, maximum `200`.
`cursor`	Cursor from the previous response’s `meta.next_cursor`.

The cursor is an opaque base64url value. Do not parse it in clients.

Errors

Errors use application/problem+json.

{
  "type": "https://bisibility.com/problems/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "Keyword not found.",
  "instance": "urn:bisibility:api:v1:/api/v1/keywords/kw_missing",
  "docs_url": "https://bisibility.com/docs/api/errors"
}

See API errors.

Get started

Product guides

API reference

SDKs

AI / Agents

Client libraries

Core resource routes

Response shapes

Errors

​Client libraries

​Core resource routes

​Response shapes

​Pagination

​Errors

Client libraries

Core resource routes

Response shapes

Pagination

Errors