API Reference

Reviews API

# Reviews API Reference

Complete reference for the Reviews API endpoints.

List Reviews

GET /agents/:id/reviews

Query Parameters

  • `sort` - Sort by (newest, helpful, rating)
  • `limit` - Number of results
  • `minRating` - Filter by minimum rating

Response

json
{
  "data": [
    {
      "id": "review-789",
      "agentId": "agent-123",
      "rating": 5,
      "title": "Excellent agent!",
      "content": "...",
      "author": "...",
      "createdAt": "2024-01-15",
      "helpful": 42,
      "unhelpful": 3
    }
  ],
  "average": 4.8,
  "total": 245
}

Get Review

GET /reviews/:id

Returns a specific review.

Create Review

POST /agents/:id/reviews

Request Body

json
{
  "rating": 5,
  "title": "Great agent",
  "content": "...",
  "useCase": "Customer support"
}

Authentication required. Requires prior usage of the agent.