Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hellocobi.com/llms.txt

Use this file to discover all available pages before exploring further.

The Cobi Recommendations API delivers personalized recommendations to enhance user engagement and improve conversion rates.

​
API Structure

All Recommendations API endpoints follow the same URL pattern: 
GET /v1/recommendations/:type/:id
Where :type is one of:
1

Customers

Get personalized recommendations for a specific customer
2

Segments

Get recommendations for a specific customer segment

​
Common Features

All endpoints require API key authentication via the Authorization header:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Contact our support team to obtain your API key.
All endpoints return a consistent response format:
[
  {
    "name": "string",
    "student_id": "string (UUID)",
    "offers": ["string (UUID)"]
  }
]
The response is an array of recommendation objects, each containing:
  • name: Human-readable name for the recommendation set
  • student_id or segment_id: Identifier for the customer or segment
  • offers: Array of offer UUIDs that are recommended
Recommendations are computationally intensive. Please be mindful of rate limits:
  • Maximum 1000 requests per minute per API key
  • Consider caching recommendations for frequently requested customers/segments

​
Available Endpoints

Customer Recommendations

Get personalized recommendations for a specific customer based on their preferences and behavior

Segment Recommendations

Get recommendations for a specific customer segment based on collective preferences

​
Best Practices

  • Cache recommendations for frequently requested customers/segments - Implement proper error handling for failed requests - Use appropriate timeouts for recommendation requests
Need help? Contact our support team at [email protected]