Make your first API call.

    Create an API key, test the connection and get schema for a page.

    Before you start

    • A plan with API access: Pro, Agency and Enterprise.
    • The owner or admin role in the workspace.
    • A workspace for your site. The examples use example.com.

    1. Create an API key

    1. Open your workspace and go to Settings.
    2. Open the Integrations tab, then API Keys.
    3. Select Generate New Key.
    4. Copy the key. It shows only once.

    Store the key in an environment variable on your server:

    Terminal
    export BRANDOP_API_KEY="YOUR_API_KEY"
    Never send the key to the browser. Call the API only from your server.

    2. Test the connection

    List the pages of the workspace. The key decides the workspace, so the request has no workspace ID.

    Request
    curl "https://brandop.ai/api/v2/pages?limit=5" \
      -H "Authorization: Bearer $BRANDOP_API_KEY"
    Response
    {
      "success": true,
      "data": {
        "pages": [
          {
            "id": "3f2b8c1e-6d4a-5b7e-9c10-2a4e6f8b0d12",
            "urlPath": "/pricing",
            "fullUrl": "https://example.com/pricing",
            "title": "Pricing",
            "isSelectedForSchema": true,
            "schemaCategory": null,
            "lastSchemaGeneratedAt": "2026-10-12T08:30:00.000Z",
            "lastCrawledAt": "2026-10-12T08:29:41.000Z",
            "currentJobStatus": "completed"
          }
        ],
        "pagination": { "page": 1, "limit": 5, "total": 42, "totalPages": 9 }
      }
    }

    limit is 50 by default and 100 at most. activeOnly=true returns only pages selected for delivery.

    3. Generate schema

    POST /schema/process runs the full flow for one URL path. It creates the page if needed and selects it for delivery. It crawls the page when there is no HTML yet. Then it starts schema generation.

    Request
    curl -X POST "https://brandop.ai/api/v2/schema/process" \
      -H "Authorization: Bearer $BRANDOP_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"urlPath": "/products/product-name"}'
    Response · 201
    {
      "success": true,
      "data": {
        "page": {
          "id": "7a1c9e3b-2f4d-5a6b-8c0d-1e2f3a4b5c6d",
          "urlPath": "/products/product-name",
          "fullUrl": "https://example.com/products/product-name",
          "isSelectedForSchema": true,
          "isNew": true
        },
        "job": {
          "id": "c4d5e6f7-8a9b-5c0d-9e1f-2a3b4c5d6e7f",
          "type": "crawl_page",
          "status": "pending"
        }
      },
      "message": "Page will be crawled and schema generated. Check job status for progress."
    }

    Generation runs in the background. If a job for the page is already running, the response returns that job.

    If the page has a manual edit, the response has hasCustomSchema: true and no job starts. To replace a manual edit, turn off Protect manually edited schemas in the workspace settings. Then regenerate the page in the panel.

    4. Get the schema

    Call GET /schema with the URL path. Forward the visitor's user agent so that Brandop can record AI bot visits. Send paths without a trailing slash. Query strings are ignored.

    Request
    curl "https://brandop.ai/api/v2/schema?urlPath=/products/product-name" \
      -H "Authorization: Bearer $BRANDOP_API_KEY" \
      -H "X-Client-User-Agent: $VISITOR_USER_AGENT"
    Response
    {
      "success": true,
      "data": {
        "page": {
          "id": "7a1c9e3b-2f4d-5a6b-8c0d-1e2f3a4b5c6d",
          "urlPath": "/products/product-name",
          "fullUrl": "https://example.com/products/product-name"
        },
        "schema": {
          "id": "9b8a7c6d-5e4f-5a3b-8c2d-1e0f9a8b7c6d",
          "jsonLd": {
            "@context": "https://schema.org",
            "@type": "Product",
            "name": "Product Name",
            "url": "https://example.com/products/product-name",
            "offers": { "@type": "Offer", "price": "49.00", "priceCurrency": "USD" }
          },
          "schemaHtml": "<script id=\"Brandop-jsonld\" type=\"application/ld+json\">{...}</script>",
          "isCustomized": false,
          "createdAt": "2026-10-12T08:30:00.000Z",
          "customizedAt": null
        }
      },
      "visitor": { "type": "human" }
    }

    A new page returns data.schema: null until its first generation finishes. A regenerated page keeps the previous schema until the new one is ready.

    Put data.schema.schemaHtml in the page <head>. It is a ready <script type="application/ld+json"> tag.

    JavaScript
    // On your server, while rendering the page
    const res = await fetch(
      `https://brandop.ai/api/v2/schema?urlPath=${encodeURIComponent(path)}`,
      {
        headers: {
          Authorization: `Bearer ${process.env.BRANDOP_API_KEY}`,
          "X-Client-User-Agent": request.headers.get("user-agent") ?? "",
        },
      },
    );
    const body = res.ok ? await res.json() : null;
    const schemaHtml = body?.data?.schema?.schemaHtml ?? "";
    // Put schemaHtml inside <head>.

    Next steps