Skip to main content
Beeze exposes a public v1 API for AI overviews, link building data, and integrations usage. The API reference in this section is generated from one OpenAPI file.

​
Base URL

Use the production API base URL for external integrations: 
https://api.beeze.io/v1
Use local development when testing against your local API server: 
http://localhost:3000/v1

​
Authentication

Every external API request must include an API key in the x-api-key header. 
curl --request GET \
  --url "https://api.beeze.io/v1/domain-research/overview/stats?project=beeze" \
  --header "x-api-key: YOUR_API_KEY"

​
Workspace selection

If the API key owner belongs to more than one workspace, include the x-workspace-id header. 
curl --request GET \
  --url "https://api.beeze.io/v1/ai-overviews/results?project=beeze" \
  --header "x-api-key: YOUR_API_KEY" \
  --header "x-workspace-id: YOUR_WORKSPACE_ID"

​
Project-scoped endpoints

Most AI overviews and link building data endpoints accept a project query parameter. When a route accepts project, you can pass the project ID, slug, or name within the selected workspace. If the identifier is ambiguous inside that workspace, use the project slug or project ID. Project-scoped public API routes also require globally unique project names across workspaces. If another workspace uses the same project name, the public API blocks those routes until the naming collision is resolved.

​
Error format

Beeze returns structured problem details for common API errors, including:
  • missing or invalid API keys
  • missing workspace context for users with multiple workspaces
  • missing feature access on the current workspace plan
  • ambiguous or missing project identifiers
  • missing resources

​
What is included today

The current public API reference covers:
  • AI overviews results, visibility, sources, competitors, prompts, and tags
  • link building summary stats, recent backlinks, team contributions, trends, backlink portfolio, and backlink market analytics
  • integrations usage
As the API grows, the reference updates from api/openapi.yaml.