# BrandPilot API

**Canonical:** https://apis.io/apis/brandpilot-dev/brandpilot-dev-api/  
**Provider:** BrandPilot — https://apis.io/providers/brandpilot-dev/  
**Documentation:** https://brandpilot.dev/docs/developers/rest-api

BrandPilot API is one of 2 APIs that [BrandPilot](https://apis.io/providers/brandpilot-dev/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

BrandPilot API as documented publicly: 27 operations. Contract generated from the documentation by API Evangelist (2026-11-03); not the provider's own document.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/mcp` | The hosted MCP ( POST /api/mcp ) serves all twelve tools below with a workspace API key. |
| GET | `/api/systems/export/{name}` | Migrating to API v2 |
| GET | `/api/v1/designs/{id}/brand-book` | GET /api/v1/designs/{id}/brand-book |
| GET | `/api/v1/designs/{id}/deck` | GET /api/v1/designs/{id}/deck Same file |
| GET | `/api/v1/designs/{id}/handoff-prompt` | GET /api/v1/designs/{id}/handoff-prompt |
| GET | `/api/v1/designs/{id}/rules-pack` | GET /api/v1/designs/{id}/rules-pack |
| GET | `/api/v1/mcp/tools` | GET /api/v1/mcp/tools The v2 tool names |
| GET | `/api/v1/me` | GET /api/v1/me Same body |
| GET | `/api/v1/openapi.json` | GET /api/v1/openapi.json |
| GET | `/api/v1/systems` | Migrating to API v2 |
| GET | `/api/v1/systems/{name}/adoption` | Migrating to API v2 |
| GET | `/api/v1/systems/{name}/agent-prompt` | Migrating to API v2 |
| GET | `/api/v1/systems/{name}/download` | Migrating to API v2 |
| DELETE | `/api/v1/systems/{name}/webhooks` | Migrating to API v2 |
| GET | `/api/v2/designs/{id}/brand-book` | READ The brand guidelines as a PDF |
| GET | `/api/v2/designs/{id}/deck` | GET /api/v2/designs/{id}/deck READ The brand deck as a PowerPoint file |
| GET | `/api/v2/designs/{id}/handoff-prompt` | READ The same contract as a markdown prompt for a text-first agent |
| GET | `/api/v2/mcp/tools` | GET /api/v2/mcp/tools The v2 tool names |
| GET | `/api/v2/me` | any |
| GET | `/api/v2/openapi.json` | GET /api/v2/openapi.json |
| GET | `/api/v2/systems` | GET /api/v2/systems |
| GET | `/api/v2/systems/{name}/adoption` | GET /api/v2/systems/{name}/adoption |
| GET | `/api/v2/systems/{name}/agent-prompt` | Markdown with copy-paste prompts for your coding agent: a Design System artifact and a Design canvas for Claude Code, local HTML drafts for other agents |
| GET | `/api/v2/systems/{name}/download` | GET /api/v2/systems/{name}/download |
| GET | `/api/v2/systems/{name}/export` | One token or component export (formats below) |
| DELETE | `/api/v2/systems/{name}/webhooks` | Migrating to API v2 |
| POST | `/api/v2/systems/{name}/webhooks` | Create a subscription |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/brandpilot-dev/openapi/_ae-authored/brandpilot-dev-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/brandpilot-dev/json-schema/brandpilot-dev-post-api-v2-systems-name-webhooks-request-schema.json

## Other BrandPilot APIs (1)

- [BrandPilot REST API](https://apis.io/apis/brandpilot-dev/brandpilot-rest-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brandpilot-dev/brandpilot-dev-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brandpilot-dev/.