Docs

Developer Quick Start

The GM Assistant API lets you manage campaigns, sessions, and their content programmatically. This guide gets you from zero to your first request.

1. Get an API key

API keys are managed from your account settings. Open your account, go to Developer, and create a key. Copy the full gma_… value when it's shown, since you won't be able to see it again.

Keep it secret. An API key grants access to your account and can spend credits. Treat it like a password and never ship it in browser, mobile, or client-side code. See Conventions & Guidelines for details.

2. Base URL

All endpoints live under the /v1 path on the API host, e.g. https://backend.gmassistant.app/v1. Send your key in the Authorization header:

Authorization: Bearer gma_<env>_<keyId>_<secret>

3. Make your first request

Head to the interactive API Reference, paste your key into the Authorize box at the top, expand an endpoint such as GET /v1/campaigns, and run it live against your account.

4. Use "test" mode analyses first

Before you run a real analysis, you can exercise the whole create, poll, and results flow for free. Pass "mode": "test" in the body of POST /v1/campaigns/<id>/sessions/<id>/analyses and the analysis skips transcription and analysis entirely, returning the same fixed, deterministic sample result every time. It charges 0 credits and ignores the session's real audio, so it's the quickest way to wire up and verify your integration before spending credits on real sessions.

Using coding tools (Claude, Cursor, and the like)?

https://backend.gmassistant.app/v1/openapi.yaml

That OpenAPI spec describes every endpoint, parameter, auth requirement, and response shape, plus a summary of our conventions.