Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.typingmind.com/llms.txt

Use this file to discover all available pages before exploring further.

The TypingMind Custom API is a REST API that lets you interact with data in the TypingMind system. It uses JSON-formatted data for requests and responses. Now, let’s explore what our API can do and how it can be used in different business cases.

​
What the TypingMind Team API can do?

You can use it to:
  • Manage users: add users, get all users, remove users, and update user details such as user tags or user groups.
  • Manage chats: create a model response for a given chat conversation.
  • Chat with an AI Agent: send a message to an AI Agent and receive a response.
  • Use the Agent’s setup: when chatting with an AI Agent via API, it can use the enabled plugins, knowledge bases, and MCP servers in the background.
Tm Api Doc

​
Use Cases

  1. User management for large team or community If you have a large team or community using your chat instance, it can be time-consuming to manually add every new user through the admin panel.
    • You can automate this task with the API. When a new user joins, it is automatically added to your chat instance. This ensures that everyone in your team has access to the chat instance as soon as they join.
    • And if a user’s role changes or if they leave the team or community, you can easily update their tags or remove their seats directly from your own platform using the API
  2. Chatbot integration
    • You can create a chatbot using the training data you have, and this chatbot can be added to any platform like Discord or Telegram.
    • The chatbot will give responses that are relevant and based on the data you have provided it during its training phase. This can be used with any language learning models (LLMs) such as ChatGPT, Claude, or any other custom LLMs, thus giving you the flexibility to use the model that best fits your requirements.

​
Get Started with TypingMind Team API

To get started with using the API:
  1. Generate an API key by logging into your instance admin panel > go to Integrations > API Integration > Generate API key
  2. Once you create a new API key, an api-user-xxxx will be added to your User list. You can then:
  • Set restrictions for the API user just like any other user
  • Track API usage by that user
  • Remove the API user if you no longer need the API key
Each API key you generate will create a separate API user. When making a request, include the API key in the request headers as X-API-KEY.
Please note that if you encounter the error like:
{
  "userMessage": "You do not have access to this agent. Please contact your admin for more information."
}
It means that the AI Agent has visibility or usage restrictions, and the user api-user-xxxx is not included in the groups that are allowed to access the agent. As a result, API requests made with that user cannot access the agent.To fix this issue:
  • Go to User Groups → Add api-user-xxxx to the group that has access to the agent.
  • Check the agent’s Visibility settings to make sure you assigned the correct group.
For more request details, please check out the documentation available on api.typingmind.com/docs. If you encounter any issues or have any questions, don’t hesitate to reach out to our support team at support@typingmind.com