API Documentation

Everything you need to integrate PULSE's real-time inference engine into your e-commerce platform.

Authentication

Learn how to authenticate your API requests

Inference API

Get real-time persona predictions

Product Tagging

Tag products with Digital Twin attributes

Webhooks

Receive real-time event notifications

Base URL

https://thepulseapi.com/v1

Authentication

All API requests require authentication using an API key. Include your key in theAuthorizationheader.

# Example request with authentication

curl -X GET "https://thepulseapi.com/v1/infer" \

-H "Authorization: Bearer YOUR_API_KEY"

Security Note: Never expose your API key in client-side code. All inference requests should be made from your backend servers.

Inference API

POST/v1/infer

Get real-time persona inference for a visitor session. Returns persona attributes, confidence scores, and recommended product rankings.

Typical latency: 25-45ms

Request Body

{
  "session_id": "sess_abc123",
  "context": {
    "device": "mobile",
    "browser": "safari",
    "referrer": "instagram.com",
    "geo": {
      "country": "US",
      "region": "CA"
    },
    "time": "2025-01-14T23:30:00Z"
  },
  "behavior": {
    "search_query": "running shoes under 100",
    "filters": ["price:0-100", "rating:4+"],
    "viewed_products": ["prod_123", "prod_456"],
    "dwell_time_ms": 45000
  }
}

Response

{
  "persona": {
    "primary": "value_conscious_runner",
    "confidence": 0.89,
    "attributes": {
      "price_sensitivity": "high",
      "brand_loyalty": "low",
      "social_proof_reliance": "high",
      "purchase_intent": "active"
    }
  },
  "recommendations": {
    "product_ids": ["prod_789", "prod_012", "prod_345"],
    "rerank_scores": [0.94, 0.91, 0.87]
  },
  "metadata": {
    "inference_time_ms": 32,
    "model_version": "v2.3.1"
  }
}

Product Tagging

POST/v1/products/tag

Generate Digital Twin tags for your products. Upload product data and receive psychographic attributes for persona matching.

Request Body

{
  "products": [
    {
      "id": "prod_123",
      "name": "Performance Running Shoe",
      "description": "Lightweight cushioned...",
      "price": 129.99,
      "category": "footwear/running",
      "image_url": "https://..."
    }
  ]
}

Webhooks

Configure webhooks to receive real-time notifications for events like persona updates, conversion tracking, and model improvements.

Available Events

•session.converted - Conversion attributed to PULSE
•products.tagged - Product tagging completed
•model.updated - Inference model improved

Rate Limits

Plan	Inference API	Tagging API
Starter	100 req/sec	10 req/sec
Growth	500 req/sec	50 req/sec
Enterprise	Custom	Custom

SDKs & Libraries

JavaScript / Node.js

npm install @pulse-ai/sdk

Python

pip install pulse-ai

Ruby

gem install pulse-ai

Need Help?

Our solutions engineering team is here to help you integrate PULSE successfully.

Get Integration Support Contact Support