# Blackpearl Developer Documentation

> Build a production-grade Blackpearl Playbooks or Audiences integration from canonical public Markdown and OpenAPI.

## Start here

- [Playbooks API primer](https://api.blackpearl.com/docs/raw/playbooks-api-primer.md): Minimal complete context for an agent implementing the golden flow.
- [OpenAPI contract](https://api.blackpearl.com/v1/openapi.json): Exact paths, schemas, authentication, enums, defaults, and errors.
- [API changelog](https://api.blackpearl.com/docs/api-changelog.md): Observable public contract and behavior changes.
- [Full documentation bundle](https://api.blackpearl.com/llms-full.txt): All public guides in deterministic order.
- [Documentation MCP server](https://api.blackpearl.com/docs/mcp/): Read-only search and canonical page retrieval.

## Guides

- [Quickstart](https://api.blackpearl.com/docs/raw/getting-started.md): Create your first job, poll it safely, and print a useful sales result.
- [Brands](https://api.blackpearl.com/docs/raw/brands.md): Turn a company name or website into a versioned, evidence-backed brand guideline.
- [Offers](https://api.blackpearl.com/docs/raw/offers.md): Reuse structured value propositions, proof points, pricing shape, ICP hints, and deal-stage fit across GTM work.
- [Campaigns](https://api.blackpearl.com/docs/raw/campaigns.md): Save repeatable targeting, bind GTM context, and run asynchronous audience cycles without granting delivery authority.
- [Audiences](https://api.blackpearl.com/docs/raw/audiences.md): Run evidence-backed audience discovery, then materialize immutable review snapshots from real prospects.
- [Playbooks](https://api.blackpearl.com/docs/raw/playbooks.md): Configure a Playbooks request and interpret every part of its typed result.
- [Playbooks integration kit](https://api.blackpearl.com/docs/raw/integration-kit.md): Run the standalone reference product or import an OpenAPI-derived request collection.
- [Documents](https://api.blackpearl.com/docs/raw/documents.md): Turn a brief, Brand Pack, and optional Offer into downloadable PPTX, DOCX, or PDF files.
- [Message Templates](https://api.blackpearl.com/docs/raw/message-templates.md): Turn approved GTM context and prospect evidence into quality-gated, approval-only outreach copy.
- [Prospecting](https://api.blackpearl.com/docs/raw/prospecting.md): Run turbo or agentic prospect discovery and poll the append-only live event thread.
- [Prospecting extensions](https://api.blackpearl.com/docs/raw/prospecting-extensions.md): Explore bounded continuation Jobs and immutable qualification rubrics without treating either contract as GA.
- [Prospect Research](https://api.blackpearl.com/docs/raw/prospect-research.md): Retrieve structured company intelligence, analyze an unindexed website, and optionally add lookalikes.
- [Professional Network](https://api.blackpearl.com/docs/raw/professional-network.md): Bind reviewed Audience members to an official Sales Navigator connection contract without scraping or execution.
- [Account Coordination](https://api.blackpearl.com/docs/raw/account-coordination.md): Derive an immutable account-level preflight from a reviewed Audience and its Outcome evidence.
- [Enrichment](https://api.blackpearl.com/docs/raw/enrichment.md): Bind reviewed Audience members to a closed enrichment field plan without calling a provider.
- [Data Intake](https://api.blackpearl.com/docs/raw/data-intake.md): Store immutable source, selection, field, deduplication, purpose, and retention contracts without executing intake.
- [Site Intelligence](https://api.blackpearl.com/docs/raw/site-intelligence.md): Store a bounded HTTPS-origin and check-profile contract without performing network or evaluation work.
- [Feedback and outcomes](https://api.blackpearl.com/docs/raw/outcomes.md): Append external prospect, account, or campaign results and aggregate them across the GTM graph.
- [Authentication and project environments](https://api.blackpearl.com/docs/raw/authentication.md): Protect project-scoped Bearer keys and isolate development, staging, and production work.
- [Jobs and resumable polling](https://api.blackpearl.com/docs/raw/jobs.md): Persist asynchronous job IDs, poll with bounded backoff, and stop on every terminal status.
- [Errors and retry decisions](https://api.blackpearl.com/docs/raw/errors.md): Branch on stable error codes and retry only operations that are safe and transient.
- [Rate limits](https://api.blackpearl.com/docs/raw/rate-limits.md): Recover from transient request-rate limits without confusing them with quota or budget exhaustion.
- [Limits, budgets, and usage](https://api.blackpearl.com/docs/raw/usage-quotas.md): Distinguish request rate, monthly quota, hard budget, credits, and Usage API counters.
- [Troubleshooting and request diagnostics](https://api.blackpearl.com/docs/raw/troubleshooting.md): Correlate a failed call, inspect organization request records, and prepare a support-safe diagnostic package.
- [Connections](https://api.blackpearl.com/docs/raw/connectors.md): Read the provider catalog and redacted project connection metadata while live connector operations remain unavailable.
- [Inspect the CRM schema preview boundary](https://api.blackpearl.com/docs/raw/crm-schema.md): Understand the Console-only HubSpot and Salesforce metadata snapshot contract and its fail-closed service boundary.
- [Capabilities and entitlements](https://api.blackpearl.com/docs/raw/feature-flags.md): Discover which capability keys the authenticated organization can use before creating work.
- [AI and machine-readable documentation](https://api.blackpearl.com/docs/raw/agent-resources.md): Fetch raw guides, documentation bundles, OpenAPI, or the read-only documentation MCP server without scraping the web application.
- [Playbooks API primer for agents](https://api.blackpearl.com/docs/raw/playbooks-api-primer.md): Give a coding agent the minimum complete contract for creating, polling, and consuming a Playbooks job safely.
- [Roles and console access](https://api.blackpearl.com/docs/raw/rbac.md): Understand console roles while keeping public API authorization project-scoped.
- [Workbench guide](https://api.blackpearl.com/docs/raw/workbench.md): Explore Playbooks inputs and results in the console before automating the public API.
- [Security and data handling](https://api.blackpearl.com/docs/raw/security-data.md): Review credential boundaries, project isolation, capability data flow, retention, and logging behavior.
- [API compatibility and deprecation](https://api.blackpearl.com/docs/raw/versioning.md): Build tolerant v1 clients and understand additive changes, previews, deprecation notices, and support windows.