API Reference

Welcome to the complete Sherpai Partner API reference. This documentation covers all available endpoints, request/response formats, and usage examples.

Base URL

Production: https://partner-api.sherp.ai

Authentication

All endpoints except /health and /auth/login require authentication via JWT tokens:

Authorization: Bearer YOUR_JWT_TOKEN

Learn more about authentication →

Endpoints Overview

Authentication

• POST /auth/login - Authenticate and get access token

User Management

• GET /me - Get current user profile

Analytics & Data

• GET /analytics/ - Get unified analytics with daily breakdown or aggregated totals
• GET /posts - Get unified posts from all platforms
• GET /me - Get current user profile with brand associations

Reference

• Glossary - Definitions of all metrics and fields available in API responses

System

• GET /health - Health check endpoint

Quick Reference

Endpoint	Method	Authentication	Description
/health	GET	None	Health check
/auth/login	POST	None	Get access token
/me	GET	Required	Current user profile
/analytics/	GET	Required	Advanced analytics (daily/aggregated)
/posts	GET	Required	Unified posts from all platforms

Response Format

All API responses use JSON format:

Success Response:

{
  "data": "Response data here",
  "...": "Additional fields"
}

Error Response:

{
  "detail": "Error description"
}

HTTP Status Codes

Code	Description	Usage
200	OK	Successful request
400	Bad Request	Invalid request parameters
401	Unauthorized	Authentication required
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
422	Validation Error	Request validation failed
429	Rate Limited	Too many requests
500	Server Error	Internal server error

SDKs and Tools

• Swagger UI - Interactive API explorer

Need Help?

• Getting Started Guide - Step-by-step setup
• Error Handling - Handle errors gracefully
• FAQ - Common questions
• Support - Contact our team

---

Choose an endpoint from the sidebar to view detailed documentation with examples and response schemas.