๐Ÿ› ๏ธ Developer Documentation

Complete API reference, SDKs, and integration guides for building on the Fit1.ai ecosystem

๐Ÿš€ Getting Started

Start integrating Fit1.ai in minutes with our comprehensive APIs

BASH
# Install Fit1.ai SDK
npm install @fit1ai/sdk

# Initialize with your API key
export FIT1_API_KEY="your_api_key_here"

# Make your first API call
curl -X GET https://api.fit1.ai/v1/campaigns \
  -H "Authorization: Bearer $FIT1_API_KEY"
โšก
RESTful API
Modern REST architecture with predictable resource-oriented URLs and comprehensive HTTP response codes
๐Ÿ”
Secure Authentication
OAuth 2.0 and API key authentication with granular permissions and rate limiting
โš™๏ธ
Webhooks
Real-time event notifications for campaign updates, conversions, and AI optimization decisions

๐Ÿ“ก Core API Endpoints

Essential endpoints for AI marketing and fitness platform integration

GET /v1/campaigns
Retrieve all active campaigns with real-time performance metrics
POST /v1/campaigns/create
Launch a new AI-optimized campaign across multiple platforms
JavaScript
// Create a new campaign
const campaign = await fit1.campaigns.create({
  name: "Summer Fitness Challenge",
  platforms: ["google", "facebook", "instagram"],
  budget: {
    daily: 500,
    currency: "USD"
  },
  targeting: {
    interests: ["fitness", "health", "wellness"],
    demographics: {
      age: { min: 18, max: 45 },
      gender: "all"
    }
  },
  aiOptimization: {
    enabled: true,
    goals: ["conversions", "engagement"],
    bidStrategy: "auto"
  }
});

console.log(`Campaign launched: ${campaign.id}`);
GET /v1/mining/status
Get current mining status and accumulated tokens
POST /v1/mining/activities
Submit fitness activities for mining validation
Parameter Type Description Required
activity_type string Type of fitness activity (workout, nutrition, sleep, etc.) Required
duration integer Activity duration in minutes Required
metrics object Activity-specific metrics (steps, calories, etc.) Optional
verification string Verification method (sensor, photo, third-party) Required

๐Ÿ“ฆ Official SDKs

Native SDKs for all major platforms and languages

JavaScript/TypeScript
v2.4.1
Python
v2.3.0
Ruby
v2.1.0
Java
v2.2.0
.NET/C#
v2.0.0
Go
v1.8.0
iOS (Swift)
v3.0.0
Android (Kotlin)
v3.0.0
Python
# Python SDK Example
from fit1ai import Client

# Initialize client
client = Client(api_key="your_api_key")

# Get AI optimization insights
insights = client.ai.get_insights(
    campaign_id="camp_123",
    metrics=["ctr", "conversions", "roas"],
    period="last_7_days"
)

# Process optimization recommendations
for recommendation in insights.recommendations:
    print(f"Action: {recommendation.action}")
    print(f"Impact: {recommendation.expected_impact}")
    
    # Auto-apply high-confidence optimizations
    if recommendation.confidence > 0.9:
        client.campaigns.apply_optimization(
            campaign_id="camp_123",
            optimization=recommendation
        )

๐Ÿ”” Webhooks & Events

Real-time notifications for critical platform events

๐Ÿ“Š
Campaign Events
campaign.created
campaign.optimized
campaign.paused
campaign.completed
โ›๏ธ
Mining Events
mining.activity_verified
mining.tokens_earned
mining.milestone_reached
mining.circle_updated
๐Ÿค–
AI Events
ai.optimization_applied
ai.anomaly_detected
ai.prediction_generated
ai.budget_rebalanced
Node.js
// Webhook endpoint example
app.post('/webhooks/fit1', (req, res) => {
  const signature = req.headers['x-fit1-signature'];
  
  // Verify webhook signature
  if (!verifyWebhookSignature(req.body, signature)) {
    return res.status(401).send('Invalid signature');
  }
  
  const event = req.body;
  
  switch(event.type) {
    case 'campaign.optimized':
      console.log(`Campaign ${event.data.campaign_id} optimized`);
      console.log(`New ROAS: ${event.data.metrics.roas}`);
      break;
      
    case 'mining.tokens_earned':
      console.log(`User earned ${event.data.amount} tokens`);
      updateUserBalance(event.data.user_id, event.data.amount);
      break;
      
    case 'ai.anomaly_detected':
      console.log(`Anomaly detected: ${event.data.description}`);
      notifyMarketingTeam(event.data);
      break;
  }
  
  res.status(200).send('OK');
});

๐ŸŽฏ Advanced Integration Features

Enterprise-grade capabilities for sophisticated implementations

๐Ÿ”„
Batch Operations
Process up to 1000 operations in a single API call for improved efficiency and reduced latency
๐Ÿ“ˆ
GraphQL API
Query exactly the data you need with our flexible GraphQL endpoint for complex data relationships
๐ŸŒ
Multi-Region Support
Global infrastructure with automatic failover and data residency compliance options
๐Ÿ”Œ
WebSocket Streams
Real-time bidirectional communication for live campaign metrics and mining updates
๐Ÿ›ก๏ธ
Enterprise Security
SOC2 compliant, end-to-end encryption, IP whitelisting, and audit logs
๐Ÿ“Š
Custom Analytics
Build custom dashboards and reports with our Analytics API and BI tool integrations

โšก Rate Limits & Performance

Designed for scale with generous limits and optimal performance

Plan Requests/Second Requests/Day Burst Limit Response Time
Developer 10 10,000 50 < 200ms
Startup 50 100,000 200 < 150ms
Business 200 1,000,000 1,000 < 100ms
Enterprise Custom Unlimited Custom < 50ms