API Documentation

Decision Intelligence API

Build place-aware applications with authentication, analytics, AI insights, and urban intelligence endpoints — documented with clear examples and token pricing.

Get StartedView Endpoints
150+
API Endpoints
99.9%
Uptime SLA
10k
Requests/min
24/7
Support

Getting Started

Authenticate once, then call any endpoint relative to the base URL.

1. Authentication

All API requests require authentication using API keys. Get your key from your dashboard.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  https://api.characterdeveloper.com/v1/analytics

2. Base URL

All API endpoints are relative to the base URL:

https://api.characterdeveloper.com/v1/

All responses are in JSON format with proper HTTP status codes.

Pricing & Tokenization

Token-based pricing — each request consumes tokens by complexity and resource usage.

Token-Based Pricing

Our API uses a token-based pricing model. Each request consumes tokens based on complexity and resource usage.

1 Token
Basic Analytics
Community metrics, basic insights
5 Tokens
AI Analysis
Sentiment analysis, predictions
10 Tokens
Complex Processing
AR experiences, computer vision

Starter

$29/month
10,000 tokens included
  • Basic analytics endpoints
  • Community insights
  • Standard support

Professional

$99/month
50,000 tokens included
  • All analytics endpoints
  • AI-powered insights
  • Priority support

Enterprise

Custom
Unlimited tokens
  • All endpoints
  • Custom integrations
  • Dedicated support

API Endpoints

Sample endpoints for analytics, insights, and AR experiences.

Analytics

GET
/analytics/community
1 token

Get community engagement metrics and participation data.

{
  "engagement_rate": 0.68,
  "active_users": 234,
  "participation_score": 8.2
}
GET
/analytics/projects
1 token

Retrieve project performance and completion metrics.

{
  "total_projects": 47,
  "completion_rate": 0.73,
  "average_satisfaction": 4.2
}

Insights

POST
/ai/sentiment-analysis
5 tokens

Analyze sentiment of community feedback and proposals.

// Request
{
  "text": "The new bike lane proposal looks great!"
}

// Response
{
  "sentiment": "positive",
  "confidence": 0.89,
  "score": 0.72
}
GET
/ai/predictions
5 tokens

Get AI-powered predictions for project success and community impact.

{
  "success_probability": 0.78,
  "impact_score": 8.4,
  "confidence_interval": [0.65, 0.91]
}

AR Experiences

GET
/ar/experiences
3 tokens

List available AR experiences for community engagement.

{
  "experiences": [
    {
      "id": "garden-guide",
      "title": "Community Garden Plant Guide",
      "participants": 23
    }
  ]
}

Rate Limits & Requirements

Rate Limits

  • Starter: 1,000 requests/hour
  • Professional: 10,000 requests/hour
  • Enterprise: Unlimited

Rate limits reset every hour. Exceeded limits return HTTP 429.

Requirements

  • Valid API key in Authorization header
  • Content-Type: application/json for POST requests
  • HTTPS required for all requests
  • User-Agent header recommended

Error Handling

Conventional HTTP status codes with detailed error payloads for debugging.

Common Status Codes

  • 200Success
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 429Rate Limited
  • 500Server Error

Error Response Format

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter",
    "details": "The 'text' field is required"
  }
}

SDKs & Libraries

JavaScript / Node.js

npm install @characterdev/api

Official SDK with TypeScript support and automatic token management.

Python

pip install characterdev-api

Python SDK with async support and built-in retry logic.

REST API

curl -X GET

Direct HTTP requests work with any programming language.

Need Help?

Our developer support team can help you integrate and scale with the Decision Intelligence API.

Contact SupportView Full Docs