Loading...

Catalyst

by Zoho
×
Cancel

ACCESS THIS PAGE
Ask AI Ready to assist

Ask me anything

How can I help you with Catalyst today?

  • AI Toolkit
    Context for LLMs NI CLI Catalyst MCP Server Catalyst AI Plugin
  • Developer Tools
    CLI
    SDK
    Java JavaScript Python Android iOS Flutter
    REST API
    Utilities
    Extensions Tools Integrations
  • Tutorials
    • Go to console

    Fetch Answer from Bot

    This API enables you to retrieve an answer from the ConvoKraft bot by submitting a transcript query. The bot will understand the question and respond with an answer based on its training.

    You can integrate this functionality into your Catalyst application using the API provided below.

    Request Details

    Request URL

    POST

    {api-domain}/convokraft/api/v1/bots/{production_botid}/answer

    copy
    api-domain
    URL
    The DC-specific domain to access Catalyst API
    project_id
    Numerical
    The unique ID of the project in which the bot has been created
    production_botid
    Numerical
    The unique ID of the ConvoKraft bot in the production environment

    Note: You can fetch the production_botid directly from the URL in the ConvoKraft service when the environment is set to Production in the console.

    For example : https://console.catalyst.zoho.com/baas/v1/project/183272829220/Production#/convokraft/bots/3828281991118

    Here, 3828281991118 is the production_botid.

    Scope

    ZIAPlatform.Convokraft.RAG.CREATE

    Request Headers

    Authorization: Zoho-oauthtoken {oauth_token}
    Content-Type: application/json
    CATALYST-ORG: {org_id}
    X-CATALYST-projectid: {project id}
    X-CATALYST-Environment: Development

    Note: The request header CATALYST-Environment: Production indicates that the API operation should be performed on the bot within the Catalyst Production environment.

    Response Details

    The API returns the answer provided by ConvoKraft based on the training material, along with the status of the answer retrieval process.

    Sample Request
    copy
    curl -X POST  
    
https://api.catalyst.zoho.com/convokraft/api/v1/bots/92738220219110/answer 
    
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’ 
    
-H ‘Content-Type: application/json’ 
    
-H ‘CATALYST-ORG: 372822922’ 
    
-H ‘X-CATALYST-projectid: 2728172727718’ 
    
-H ‘X-CATALYST-Environment: “Production”’ 
    
--data ‘{
“transcript”: {
“message”: “Explain Iphone 11 Specifications”
}
}’
    Sample Response
    copy
    {
“transcript”: {
“message”: “The iPhone 11 is a sleek and powerful smartphone from Apple, featuring a 6.1-inch Liquid Retina HD display that offers vibrant colors and sharp detail. It’s powered by the A13 Bionic chip, which ensures fast performance and smooth multitasking. Whether you’re gaming, editing photos, or using apps, the iPhone 11 can handle it with ease.
One of the standout features of the iPhone 11 is its camera system. It has a dual-camera setup, with a 12MP wide and ultra-wide lens, making it great for capturing detailed photos and videos. The Night Mode feature helps take clearer pictures in low-light environments, and it also supports 4K video recording at 60fps, allowing you to shoot high-quality videos.”,
“status”: “action_completion”
}
}