research-reports

Analyze AI visibility

Changed on

Requires an explicit cost cap. estimate_only makes no paid request. Observed AI datasets and synthetic prompt tests remain distinct.

post/projects/{project_id}/ai-visibility

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/ai-visibility
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:write)

Path parameters

project_idstring required

The public project ID. Project membership and token scopes are enforced.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Request body

brandstring required

Brand name to inspect.

domainstring required

Local citation-matching hostname, without a scheme or path. Domain searches remove a leading www. only from the provider filter and require at most 63 characters after removal; local matching keeps the full hostname. Brand searches and prompt comparisons allow up to 253.

max_cost_centsinteger required

Maximum accepted provider cost in cents. Estimates and cache reads do not spend credits.

estimate_onlyboolean

Return the cost estimate without paid provider I/O.

freshboolean

Bypass the stored result and issue a new paid request when admitted.

target_type'brand' | 'domain'

Match a brand name or a domain.

platform'chat_gpt' | 'google'

Provider observed dataset: ChatGPT or Google AI Overview.

location_codeinteger

Provider location code.

language_codestring

Dataset language.

limitinteger

Maximum mention rows.

Response

Project-scoped result

Changes