Skip to main content

AI SmartTalk API Documentation

Welcome to the AI SmartTalk API documentation. Our API allows you to seamlessly integrate powerful AI-driven conversation capabilities into your applications.

Available Endpoints​

Document Search API​

  • Endpoint: /api/v1/documents/getRelevantDocuments
  • Method: POST
  • Description: Searches and returns relevant documents based on a query using vector similarity search. The endpoint requires authentication via a token and returns up to 20 most relevant documents. If no documents are found, it returns a 404 status.
  • Required Parameters:
    • chatModelId: The ID of the chat model to use
    • query: The search query text
  • Learn more about Document Search API

Document Import API​

  • Endpoint: /api/v1/documents/source
  • Method: POST
  • Description: Processes and imports documents in batch from various sources. Supports different source types including FAQ, IMPORTED_PRODUCT, and DEFAULT. Documents are processed asynchronously through a message queue system.
  • Required Parameters:
    • documentDatas: Array of documents containing id, title, content, and other metadata
    • source: Source type (FAQ, IMPORTED_PRODUCT, or DEFAULT)
    • chatModelId: The ID of the chat model
  • Learn more about Document Import

Personal Chat Admin API​

  • Endpoint: /api/v1/documents/mySmartAdmin
  • Method: POST
  • Description: Provides a secure interface for interacting with a personal chat admin. Includes rate limiting (30 requests per minute) and validates chat instance ownership. Supports multilingual interactions through language specification.
  • Required Parameters:
    • userId: The ID of the user
    • chatModelId: The ID of the chat model
    • chatInstanceId: The ID of the chat instance
    • query: The message to send to the admin
    • lang (optional): Language preference for the response
  • Learn more about Personal Chat Admin

More Endpoints Coming Soon​

We're constantly working on expanding our API capabilities. Stay tuned for additional endpoints!

Getting Started​

  1. Create an account or sign in to your existing account.
  2. Navigate to the API section in your dashboard to obtain your API credentials.
  3. Get your authorization token from Fast Integration -> Web Integration section. You'll need to include this token in the Authorization header of all API requests: 
    Authorization: Bearer your_token_here
  4. Explore our API documentation to understand the available endpoints and how to use them.
  5. Start integrating AI-powered conversations into your applications!

For any questions or support, please don't hesitate to contact us by email at contact@aismarttalk.tech.