Adspire.AI API Docs

Easy to Use

Adspire.AI API docs was designed to be easily installed and used to get your connector up and running quickly.

Focus on What Matters

Adspire.AI lets you focus on your connector, not on the infrastructure. We take care of process and guideses, so you can focus on building your connector and optimizing your event flow.

Powered by Adspire.AI

Extend or customize your company processes by implementing custom connectors. Adspire.AI can be extended while reusing the same logic across multiple connectors.

Integration quickstart

Use these examples to generate your API token, send valid webhook payloads, and model Brand Graph / Holo events.

1) Generate API key (JWT token)

Create a connector user and request a token from POST /api/auth/login. Use that token in Authorization: Bearer <jwt>.

{
  "email": "connector@yourcompany.com",
  "password": "your-strong-password"
}

Full auth docs: /auth

2) Webhook payload contract

Send events to POST /api/webhook-events with event_type and payload.

{
  "event_type": "shopify.orders/create",
  "payload": {
    "id": 123,
    "total_price": "29.99",
    "_meta": {
      "source": "shopify",
      "topic": "orders/create",
      "request_id": "uuid"
    }
  }
}

Payload reference: /webhooks

3) Brand Graph + Holo API events

Model Holo events using stable event_type naming and include entity identifiers in _meta so events can be resolved into Brand Graph signals.

{
  "event_type": "holo.asset.updated",
  "payload": {
    "asset_id": "asset_123",
    "status": "approved",
    "_meta": {
      "source": "holo",
      "topic": "asset.updated",
      "brand_id": "brand_42",
      "request_id": "uuid"
    }
  }
}

Architecture details: /connector-overview