• English

      • Open Platform API

      Release date: October 22, 2026

      The HeiChat Open Platform API is now available. Use your own system to read conversations and manage the knowledge base, and connect HeiChat to the support tools, CRM, or internal tools you already use.

      Requests use the Base URL shown on the credential page, and every request must use HTTPS. Send your Access Key and Secret with each request. The Secret is shown only once, when it is created. Do not put it in frontend code, query parameters, or logs.

      Two capabilities are available now:

      • Knowledge base. List, get, and delete knowledge entries, or create a manual-input entry — the same kind of entry you would type in the admin app.
      • Conversations. Filter conversations by time, status, email, and tags, then read one conversation and its messages.

      Limits are applied per shop, not per Access Key. Shops without a paid plan get 10 requests per minute and 1,000 per month. Pro Basic and Pro get 10 per minute and 5,000 per month. Pro Plus and above get 30 per minute and 20,000 per month. The month is a UTC calendar month.

      See Open Platform API for the endpoints, authentication, and error codes.