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. Use the same registration and review process for every connector, then choose the event, sync, webhook, and action patterns that fit your integration.

Powered by Adspire.AI

Extend your company processes with connectors built for your needs. Every connector follows the same registration and approval process before becoming available to users generally.

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": "provider.resource/updated",
  "payload": {
    "resource_id": "resource_123",
    "status": "updated",
    "_meta": {
      "source": "provider",
      "topic": "resource/updated",
      "request_id": "uuid"
    }
  }
}

Payload reference: /webhooks

3) Reliable resource events

Use stable event_type names and include relevant resource identifiers in _meta to help downstream systems process events.

{
  "event_type": "provider.resource/updated",
  "payload": {
    "resource_id": "resource_123",
    "status": "updated",
    "_meta": {
      "source": "provider",
      "topic": "resource/updated",
      "request_id": "uuid"
    }
  }
}

Architecture details: /connector-overview