BrandPilot

BrandPilot API

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

GitHub OpenAPI

Operations 27

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 #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/brandpilot-dev/openapi/_ae-authored/brandpilot-dev-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/brandpilot-dev/json-schema/brandpilot-dev-post-api-v2-systems-name-webhooks-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/brandpilot-dev:brandpilot-dev-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

brandpilot-dev-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: BrandPilot API
  version: '2026-11-03'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-03: 27 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; BrandPilot has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 23
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-03'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://brandpilot.dev/docs/developers/rest-api
  - https://brandpilot.dev/docs/developers/api-keys
  - https://brandpilot.dev/docs/developers/webhooks
  - https://brandpilot.dev/docs/developers/migration-v2
  - https://brandpilot.dev/docs/developers/mcp-tools
paths:
  /api/mcp:
    post:
      operationId: post_api_mcp
      tags:
      - Api
      summary: The hosted MCP ( POST /api/mcp ) serves all twelve tools below with a workspace API key.
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/systems/export/{name}:
    get:
      operationId: get_api_systems_export_name
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/designs/{id}/brand-book:
    get:
      operationId: get_api_v1_designs_id_brand_book
      tags:
      - Api
      summary: GET /api/v1/designs/{id}/brand-book
      description: Same file
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/designs/{id}/deck:
    get:
      operationId: get_api_v1_designs_id_deck
      tags:
      - Api
      summary: GET /api/v1/designs/{id}/deck Same file
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/designs/{id}/handoff-prompt:
    get:
      operationId: get_api_v1_designs_id_handoff_prompt
      tags:
      - Api
      summary: GET /api/v1/designs/{id}/handoff-prompt
      description: Always written for an API key
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/designs/{id}/rules-pack:
    get:
      operationId: get_api_v1_designs_id_rules_pack
      tags:
      - Api
      summary: GET /api/v1/designs/{id}/rules-pack
      description: Same body
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/mcp/tools:
    get:
      operationId: get_api_v1_mcp_tools
      tags:
      - Api
      summary: GET /api/v1/mcp/tools The v2 tool names
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/me:
    get:
      operationId: get_api_v1_me
      tags:
      - Api
      summary: GET /api/v1/me Same body
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/openapi.json:
    get:
      operationId: get_api_v1_openapi_json
      tags:
      - Api
      summary: GET /api/v1/openapi.json
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/systems:
    get:
      operationId: get_api_v1_systems
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/systems/{name}/adoption:
    get:
      operationId: get_api_v1_systems_name_adoption
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/systems/{name}/agent-prompt:
    get:
      operationId: get_api_v1_systems_name_agent_prompt
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/systems/{name}/download:
    get:
      operationId: get_api_v1_systems_name_download
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/systems/{name}/webhooks:
    delete:
      operationId: delete_api_v1_systems_name_webhooks
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/designs/{id}/brand-book:
    get:
      operationId: get_api_v2_designs_id_brand_book
      tags:
      - Api
      summary: READ The brand guidelines as a PDF
      description: Returns the brand book PDF.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/designs/{id}/deck:
    get:
      operationId: get_api_v2_designs_id_deck
      tags:
      - Api
      summary: GET /api/v2/designs/{id}/deck READ The brand deck as a PowerPoint file
      description: Returns the brand deck as a PowerPoint file.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/designs/{id}/handoff-prompt:
    get:
      operationId: get_api_v2_designs_id_handoff_prompt
      tags:
      - Api
      summary: READ The same contract as a markdown prompt for a text-first agent
      description: Returns the handoff contract as a markdown prompt.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/mcp/tools:
    get:
      operationId: get_api_v2_mcp_tools
      tags:
      - Api
      summary: GET /api/v2/mcp/tools The v2 tool names
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/me:
    get:
      operationId: get_api_v2_me
      tags:
      - Api
      summary: any
      description: Returns the workspace, key name and permissions.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/openapi.json:
    get:
      operationId: get_api_v2_openapi_json
      tags:
      - Api
      summary: GET /api/v2/openapi.json
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/systems:
    get:
      operationId: get_api_v2_systems
      tags:
      - Api
      summary: GET /api/v2/systems
      x-source: https://brandpilot.dev/docs/developers/rest-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl https://brandpilot.dev/api/v2/systems
  /api/v2/systems/{name}/adoption:
    get:
      operationId: get_api_v2_systems_name_adoption
      tags:
      - Api
      summary: GET /api/v2/systems/{name}/adoption
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl https://brandpilot.dev/api/v2/systems/{name}/adoption
  /api/v2/systems/{name}/agent-prompt:
    get:
      operationId: get_api_v2_systems_name_agent_prompt
      tags:
      - Api
      summary: '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'
      description: Returns markdown prompts for the coding agent.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/systems/{name}/download:
    get:
      operationId: get_api_v2_systems_name_download
      tags:
      - Api
      summary: GET /api/v2/systems/{name}/download
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -O https://brandpilot.dev/api/v2/systems/{name}/download Public endpoints (no key) Method Endpoint Returns GET /api/v2/systems
          The published brand systems, ACTIVE only. Filter: platform (NEXTJS, WORDPRESS) GET /api/v2/systems/{name}/adoption The manifest: tokens,
          components, pages, brand assets and export formats GET /api/v2/systems/{name}/download A ZIP bundle with every file GET /api/v2/sys'
  /api/v2/systems/{name}/export:
    get:
      operationId: get_api_v2_systems_name_export
      tags:
      - Api
      summary: One token or component export (formats below)
      description: Exports a token or component in the requested format.
      x-source: https://brandpilot.dev/docs/developers/rest-api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
        description: Export format (e.g., globals-css, colors-ts, tailwind-theme, etc.)
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/systems/{name}/webhooks:
    delete:
      operationId: delete_api_v2_systems_name_webhooks
      tags:
      - Api
      summary: Migrating to API v2
      x-source: https://brandpilot.dev/docs/developers/migration-v2
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v2_systems_name_webhooks
      tags:
      - Api
      summary: Create a subscription
      description: Register a webhook subscription for a brand system. The request body must be JSON with `targetUrl` and `events`.
      x-source: https://brandpilot.dev/docs/developers/webhooks
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2SystemsNameWebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV2SystemsNameWebhooksRequest:
      type: object
      properties:
        targetUrl:
          type: string
          description: The public HTTPS URL that will receive the webhook POSTs
        events:
          type: array
          description: List of event names to subscribe to, e.g., "system.published", "system.updated"
      required:
      - targetUrl
      - events
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api