API Reference

VectorGap API docs
for agency implementations

Use the API when your agency is ready to connect VectorGap signals into client reporting, dashboards, and recurring GEO delivery workflows across a portfolio.

RESTful Design

Clean, predictable endpoints following REST conventions. JSON request and response bodies.

API Key Auth

Authenticate with `Authorization: Bearer <api_key>`. Generate and manage keys from your dashboard.

Rate Limiting

Rate limits and endpoint availability vary by plan and implementation status. Check the live docs and dashboard before depending on a specific quota.

Webhooks

Webhook support exists for selected events. Treat coverage as plan- and implementation-dependent until confirmed in your workspace.

API Endpoints

Current endpoints for managing brands, audits, analytics, and webhooks.

GET/v1/brands
POST/v1/brands
GET/v1/brands/{id}
POST/v1/brands/{id}/audits
GET/v1/brands/{id}/analytics
POST/v1/webhooks

Quick Start

Start by listing the brands available to your workspace.

// JavaScript/TypeScript
const response = await fetch('https://www.vectorgap.ai/api/v1/brands', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

// Response:
// {
//   "data": [
//     {
//       "id": "brand_123",
//       "brandName": "Acme Corp",
//       "domain": "acme.com",
//       "industry": "Technology",
//       "description": "AI infrastructure platform",
//       "createdAt": "2026-01-14T10:30:00Z",
//       "updatedAt": "2026-01-15T08:20:00Z"
//     }
//   ],
//   "meta": {
//     "total": 1
//   }
// }

Full Documentation

Current API reference, examples, and caveats for supported endpoints.

Open docs

SDK Libraries

Official SDKs for Node.js, Python, and Go. Coming soon.

Coming Q2 2026

Need implementation details for client reporting?

The API page is a late-stage validation surface. Use the docs as the single next step, then confirm current plan limits and endpoint coverage before shipping dependencies.