Skip to main content

API & AI agents

Your eChat workspace can be reached from outside the eChat backend:

  • An AI assistant - Claude, ChatGPT, or another assistant that supports MCP - connects to your workspace and answers questions like "show me yesterday's chats where someone left an email address", or curates your FAQ. See Connect an AI assistant.
  • A script or a CRM reads conversations through a GraphQL endpoint, for example to sync new leads every night. See GraphQL API.
  • The knowledge base can be filled from outside Magento through a REST API. See Knowledge base REST API.

The connection details for an AI assistant and for scripts are in the eChat backend under Settings -> API & MCP.

Credentials​

CredentialUsed byWhere to find it
Signing in with OAuthAI assistants that connect by signing in, such as Claude and ChatGPTNothing to copy: the assistant asks you to approve the connection
Access keyAI assistants configured with a header, and scripts using the GraphQL APISettings -> API & MCP
Secret KeyThe knowledge base REST API, and the Magento extension itselfMagento admin, the Account panel of the eChat settings

The access key and the secret key are separate. Changing one does not affect the other.

What an assistant or a script can do​

A connected assistant or script can read your conversations, knowledge base, FAQ, guidance and settings, and change your knowledge base, FAQ, guidance and settings. An assistant connected with read access only is given only the tools that read, and cannot change anything.

It cannot:

  • change billing - apply or cancel a coupon, extend a trial
  • read or change your AI provider keys
  • rename, remove or merge workspaces
  • read or change the access key, or disconnect other assistants
  • delete conversations or visitor data, or change how long conversations are kept

Limits​

  • Up to 60 requests a minute per workspace, counted together for AI assistants and the GraphQL API. Past that, a request is answered 429 with a Retry-After header telling you how many seconds to wait.
  • Up to 100 items per page (perPage).
  • A request with a missing or wrong credential is answered with 401.

Manage access​

In Settings -> API & MCP:

  • Connected assistants lists every assistant you approved, with what it may do and when it was last used. Disconnect stops it at once.
  • Regenerate key replaces the access key. Every script and assistant using the old key stops working immediately; update them with the new key. Assistants connected by signing in stay connected.