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