> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beeze.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Beeze API

> Authenticate with API keys, select a workspace when needed, and use the public v1 API

Beeze exposes a public `v1` API for AI Search, 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:

```bash theme={null}
https://api.beeze.io/v1
```

Use local development when testing against your local API server:

```bash theme={null}
http://localhost:3000/v1
```

## Authentication

Every external API request must include an API key in the `x-api-key` header.

```bash theme={null}
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.

```bash theme={null}
curl --request GET \
  --url "https://api.beeze.io/v1/ai-search/results?project=beeze" \
  --header "x-api-key: YOUR_API_KEY" \
  --header "x-workspace-id: YOUR_WORKSPACE_ID"
```

## Project-scoped endpoints

Most AI Search 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 Search 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`.