Get started with the INSIDE Gateway

The INSIDE Gateway is a single, secure entry point to INSIDE customer service data. Server applications, coding agents and other agents use it to read conversations, contacts, reports and configuration metadata for the websites they have been granted. They can also make a small set of reviewed changes, such as adding a visitor note.

How it works

Every call is made by an application installation. You decide what each installation can reach, and the Gateway checks those grants again on every request.

Level	What it holds
Organization	Your business. It owns websites, members and applications.
Application	One integration or agent. It holds the granted websites, scopes, data access flags, restrictions and author mappings.
Installation	The application installed for its organization. It inherits the application’s limits.
Credential	An expiring secret for one installation. It can narrow scopes and websites further. Its token is shown once.

A credential can never exceed its application’s limits, and new websites are never granted automatically.

Interfaces

Interface	Address	Use it for
REST API	https://api.inside.chat/api/v1	Server integrations
Business MCP	https://api.inside.chat/mcp	Coding agents and assistants that call tools
Business A2A	https://api.inside.chat/a2a	Agents that send structured tasks
OAuth 2.0	https://api.inside.chat/oauth/token	Short-lived tokens bound to one interface

All three interfaces share the same operations, permissions and quotas.

Get started in three steps

1. Create an app and a credential. An organization owner or admin creates an application, an installation and an expiring credential in the Gateway console.

2. Check your access. Call GET /api/v1/context with the token to see what the credential can do.

3. Call the API or connect an agent. Read data through the REST API, or add the MCP server to your AI agent.

Create an app and a credential

Make your first request

Choose an authentication method

Connect an AI agent

What’s available today

The Gateway returns stored INSIDE data. Live, unsaved state, such as an in-progress chat, isn’t included. Many responses carry a coverage label that says where the data came from.

Not available yet:

• Sending replies, or starting, transferring or closing conversations
• Contact updates and file uploads
• Full event payloads. Events are payload-free change receipts.
• Creating webhooks through the API. Set them up in the console.
• Streaming and push notifications for A2A
• Shopper-facing agents

Follow the changelog for new capabilities.

Check what your environment runs

A hosted environment can run an earlier release than these docs describe. Check its /version.json and live /api/v1/openapi.json. Some operations also need a matching connector version on the website’s INSIDE cluster. Without it, calls return 503 or 502.