API Reference

https://api.goldilocks.chat/v1

Authorization: Bearer your-api-key

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Description of the error"
  }
}

GET /documents

{
  "success": true,
  "data": {
    "documents": [
      {
        "id": "doc_abc123",
        "title": "Return Policy",
        "status": "active",
        "createdAt": "2024-01-15T10:00:00Z",
        "updatedAt": "2024-01-15T10:00:00Z"
      }
    ],
    "total": 42,
    "limit": 20,
    "offset": 0
  }
}

GET /documents/:id

{
  "success": true,
  "data": {
    "id": "doc_abc123",
    "title": "Return Policy",
    "content": "Our return policy allows...",
    "status": "active",
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-15T10:00:00Z"
  }
}

POST /documents

{
  "title": "New Document",
  "content": "Document content here...",
  "status": "active"
}

{
  "success": true,
  "data": {
    "id": "doc_new123",
    "title": "New Document",
    "status": "active",
    "createdAt": "2024-01-15T10:00:00Z"
  }
}

PUT /documents/:id

{
  "title": "Updated Title",
  "content": "Updated content...",
  "status": "active"
}

DELETE /documents/:id

{
  "success": true,
  "data": {
    "deleted": true
  }
}

GET /faqs

GET /faqs/:id

POST /faqs

{
  "question": "How do I reset my password?",
  "answer": "To reset your password...",
  "category": "account",
  "status": "approved"
}

PUT /faqs/:id

DELETE /faqs/:id

GET /conversations

GET /conversations/:id

{
  "success": true,
  "data": {
    "id": "conv_abc123",
    "customerId": "cust_12345",
    "status": "ended",
    "messages": [
      {
        "role": "customer",
        "content": "How do I return my order?",
        "timestamp": "2024-01-15T10:00:00Z"
      },
      {
        "role": "assistant",
        "content": "To return your order...",
        "timestamp": "2024-01-15T10:00:05Z",
        "sources": ["doc_abc123"]
      }
    ],
    "tags": ["returns", "orders"],
    "createdAt": "2024-01-15T10:00:00Z",
    "endedAt": "2024-01-15T10:05:00Z"
  }
}

GET /analytics/overview

{
  "success": true,
  "data": {
    "conversations": 1234,
    "messages": 5678,
    "resolutionRate": 0.78,
    "escalationRate": 0.15,
    "averageMessages": 4.6
  }
}

GET /analytics/topics

{
  "success": true,
  "data": {
    "topics": [
      { "name": "Shipping", "count": 245, "percentage": 0.23 },
      { "name": "Returns", "count": 189, "percentage": 0.18 }
    ]
  }
}

GET /webhooks

POST /webhooks

{
  "url": "https://yoursite.com/webhook",
  "events": ["conversation.started", "conversation.escalated"],
  "secret": "your-webhook-secret"
}

PUT /webhooks/:id

DELETE /webhooks/:id

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1640000000