Getting started

What you need

Three things, and two of them come from us.

• A key, and the site id that goes with it. Both are issued when your engagement begins.
• The base URL for your deployment. It arrives with the key, because where your platform runs is your decision rather than ours.
• A client. Anything that can send an HTTP request will do, and to connect your own agents you bring a Model Context Protocol (MCP) client as well.

Making your first call

Everything the API does goes through one endpoint, and what you are asking for is an event name sent in the body. Some events need no credential, which makes one of them the shortest way to a first response.

POST /api/v1/platform
X-Site-Id: <your site id>
Content-Type: application/x-www-form-urlencoded

event_type_name=site.stats

The body is form encoded, not JSON. X-Site-Id goes on every request, not only the first. And the response is an HTML fragment unless you ask for something else: send Accept: application/json and an event with a JSON output answers in JSON.

Your key goes in the x-gisdwai-api-key header, and it opens the events that require one.

Every response carries a trace id in the x-trace-id header. The header is exposed to browser callers too. That id is the first thing to quote if you ask us about a call.

What an event expects

Ask what an event expects and the platform answers, with no credential needed at all.

GET /api/v1/platform/_schema/site.stats

Back comes standard JSON Schema for that event's input, and the same response says whether the event answers in JSON or with an HTML fragment. You can read it, or point a generator at it, before you hold a key.

Connecting your own agents

Your agents reach the platform through an MCP server, which exposes its capability to them as tools. Point a streamable HTTP MCP client at the endpoint issued with your key, authenticate with that same key, and the tools appear in the client you already use.

Which tools your key reaches is set up with you.