Qnas
List Q&As
Retrieve a paginated list of Q&A entries for a project. Supports full-text search using websearch_to_tsquery, along with pagination controls.
Path Parameters
projectIdstring
The project ID to fetch Q&As for
Format
uuid
Query Parameters
query?string
Optional search query. When provided, performs a full-text search on the question/title.
Length
length <= 300
limit?number
Maximum number of items to return
Default
10
Range
1 <= value <= 100
offset?number | null
Number of items to skip before starting to collect the result set
Default
0
Range
0 <= value
Response Body
curl -X GET "https://api.siteassist.io/v2/projects/123e4567-e89b-12d3-a456-426614174000/qnas?query=refund+policy&limit=10&offset=0"
{
"object": "list",
"total": 1,
"limit": 10,
"offset": 0,
"data": [
{
"object": "qna",
"id": "c2a19f0e-8bcb-4a67-9e4a-8f7b8f5d8d2a",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"question": "What is your refund policy?",
"answer": "You can request a refund within 30 days of purchase.",
"createdBy": {
"name": "Alex",
"image": null
}
}
]
}
{
"error": {
"message": "Invalid request body. Content is required.",
"code": "INVALID_REQUEST_BODY",
"details": {
"field": "content"
}
}
}
{
"error": {
"message": "Authentication required",
"code": "UNAUTHORIZED"
}
}
{
"error": {
"message": "A higher pricing plan is required to access this feature",
"code": "PAYMENT_REQUIRED",
"details": {
"currentPlan": "free",
"requiredPlan": "pro",
"feature": "advanced_ai_models"
}
}
}
{
"error": {
"message": "Access denied to this conversation",
"code": "FORBIDDEN"
}
}
{
"error": {
"message": "Conversation not found!",
"code": "CONVERSATION_NOT_FOUND",
"details": {
"conversationId": "123e4567-e89b-12d3-a456-426614174000"
}
}
}
{
"error": {
"message": "Resource already exists",
"code": "CONFLICT",
"details": {
"resource": "conversation",
"conflictingField": "id"
}
}
}
{
"error": {
"message": "Validation failed",
"code": "VALIDATION_ERROR",
"details": {
"field": "content",
"reason": "Content exceeds maximum length of 10000 characters"
}
}
}
{
"error": {
"message": "Rate limit exceeded. Please try again later.",
"code": "RATE_LIMIT_EXCEEDED",
"details": {
"retryAfter": 60
}
}
}
{
"error": {
"message": "An internal server error occurred",
"code": "INTERNAL_SERVER_ERROR"
}
}
{
"error": {
"message": "Service temporarily unavailable",
"code": "BAD_GATEWAY",
"details": {
"service": "ai_model_service"
}
}
}
{
"error": {
"message": "Service temporarily unavailable",
"code": "SERVICE_UNAVAILABLE",
"details": {
"retryAfter": 30
}
}
}