Skip to content
Mindtickle Developer DocsBeta

Try searching for

↑↓ to navigate↵ to openesc to close
Dark mode

Copilot

Mindtickle Copilot APIs embed the AI-powered assistant in your own applications, chatbots, and workflows, with streaming responses and citations.

View as Markdown(opens in a new tab)
Use with AI

Open this page in

ChatGPT(opens in a new tab)Claude(opens in a new tab)Cursor(opens in a new tab)

Mindtickle Copilot APIs let you embed the AI-powered assistant directly into your custom applications, chatbots, and workflows. You can query assigned and public modules, assets, and Call AI recordings to retrieve real-time answers for tasks such as pre-call preparation, post-call follow-ups, and product inquiries.

Key capabilities

Section titled “Key capabilities”
  • Integration: Embed AI-powered conversations directly into your existing tools and interfaces.
  • Real-time streaming: Receive token-by-token responses for an interactive user experience.
  • Context awareness: Maintain conversational history to support multi-turn interactions and follow-up questions.
  • Access control: All interactions follow Mindtickle’s existing permissions and access controls, authenticated with JWTs.

Prerequisites and shared context

Section titled “Prerequisites and shared context”

To interact with the API, you must be familiar with the following platform standards. See Authentication and setup.

  • Authentication: How to generate and use your bearer token.
  • Base URLs: Determining the correct regional endpoint for your account.
  • Rate limits: Understanding platform quotas and retry logic.
  • Conventions: Standard JSON data formats and HTTP status codes.

Availability and access control:

  • The Mindtickle Copilot API is not enabled by default and requires the Seller Copilot feature to be active on your Mindtickle instance. To enable both the feature and the API, contact your customer success manager or Mindtickle Support.
  • Only users authorized by an admin can use the API. Admins control access from the admin site under Account > Settings > Seller Copilot with the Audience setting, for example all users, specific groups, or fully restricted.

Seller Copilot is also available on the learning site, Slack, Salesforce, and the Mindtickle mobile app.

In this category

Section titled “In this category”
  • Seller Copilot: the chat endpoint for AI-powered conversations with the assistant.
    • Send a chat message: send a prompt, continue a conversation with context, and stream the assistant reply.