Superseek Docs
WebsiteSign In
  • 👋Welcome to Superseek
  • Getting Started
    • 💡What is Superseek?
    • đŸ”ŦHow Superseek works
    • 🚀Quick Start
  • Using Superseek
    • â„šī¸AI Knowledge Base
      • Add your website content
      • Add your help content
      • Add your documents
      • Add custom content
      • Add answer correction
      • Delete content
    • 🤖AI Settings
      • Customize AI instructions
      • Change AI model
    • 🎨Customize Appearance
    • 👩Fallback, Routing â‚Ŧ Human Handoff
      • Add Fallback Response
      • Handoff to live chat
        • Handoff to Intercom
        • Handoff to Zendesk
        • Handoff to Hubspot
        • Handoff to Freshchat
        • Handoff to Crisp
        • Handoff to Tidio
        • Handoff to Zoho SalesIQ
        • Handoff to Tawk.to
      • Add Routing Buttons
    • 👤Lead Forms
    • đŸ“ŦInbox
    • đŸ’ŦInstall chat widget
    • 🎇Improve AI answers
    • 🛑Usage Limits
  • My Account
    • 👩‍đŸ’ŧYour Profile
    • đŸ’ŗSubscription & Billing
      • Update payment card
      • Download past invoices
      • Cancel Subscription
  • API Documentation
    • đŸĨ…API Overview
    • 🔮Q&A API
    • 💭Chat API
    • đŸ”ŧAnswer Rating API
    • đŸŽŸī¸Generate Session ID API
Powered by GitBook
On this page
  1. API Documentation

Answer Rating API

Use the answer rating API to track the ratings for the bot's answers.

The Answer Rating API is useful for tracking quality metrics related to the bot's responses. Use this endpoint to enable users to rate answers (good or bad) and track it in your inbox.

POST https://admin.superseek.ai/answer-rating

Use this endpoint to enable users to rate answers (good or bad) and track it in your inbox.

Request Body

Name
Type
Description

api_key*

String

API key of the account

bot_id*

Number

Unique identifier of the bot

answer_id*

String

The unique identifier of each answer provided by the bot

rating*

Number

Pass 1 for a good rating and -1 for a bad rating

{
    "chat": [
        {
            "role": "user",
            "question": "What is Superseek?",
            "timeStamp": "Mon Jan 8 2024 12:53:11 UTC"
        },
        {
            "role": "bot",
            "result": {
                "text": "Superseek is a platform to create custom AI assistants.",
                "ref": [
                    {
                        "url": "https://superseek.ai",
                        "title": "Superseek: Create AI assistants"
                    }
                ],
                "urlPresent": true
            },
            "fallback": false,
            "timeStamp": "Mon Jan 8 2024 12:53:11 UTC",
            "like": true,
            "dislike": false
        }
    ],
    "rating": "1"
}

PreviousChat APINextGenerate Session ID API

Last updated 1 year ago

đŸ”ŧ