Skip to content
Game Market Copilot Docs
Esc
navigateopen⌘Jpreview
On this page

API Endpoints

Endpoint families in the GMC REST API, with links to the authoritative OpenAPI contract for exact parameters and fields.

This page maps the endpoint families available under /api/v1. It is a guide to what exists and where to look, not a parameter reference. For exact request parameters, field shapes, and enums, use the contract sources linked at the bottom of each section and on /api/overview.

All endpoints below share the response envelope, error codes, and credit/rate limit behavior described in /api/overview.

Games and Steam catalog

Search the Steam catalog, count matches, run grouped aggregates, look up a single title by ID, resolve a title by name, and pull per-title review and marketing analysis.

  • Catalog search, count, and aggregate (grouped metrics such as count or median reviews by release year, price bucket, or tag).
  • Per-title detail, batch detail lookup, and name-to-ID resolution.
  • Per-title review topics, review claims, deeper analysis sections, and success-report summaries.

Search, count, and aggregate accept a tags filter; unknown tag slugs return INVALID_TAG with suggestions, so resolve tags via the tag catalog first. Per- title analysis and success-report calls fall in the higher cost classes described in /api/overview since they synthesize review and marketing data for a single title; catalog search, count, and detail sit at or near the baseline.

Showcases

Search the showcase catalog and check how well a title fits an upcoming showcase window, including deadline-aware filtering.

Game lists

Create, read, update, and delete workspace game lists, and manage the games inside a list. Used to build a saved set of titles for later cohort analysis or comparison, from either the dashboard or an agent.

Saved filters

Save and reuse a catalog search definition (tags, review/rating/price bounds, sort) as a named filter, so a search doesn’t have to be reconstructed on every call.

Tags

Look up the tag taxonomy: list all known tags, or search by free-text term. Unmetered and available without a paid plan, since every tag-filtered endpoint depends on it to resolve valid slugs.

Account, status, and usage

Check workspace status and entitlements, and review API key and CLI credential usage, including per-call credit charges over time. Use these endpoints (or the equivalent CLI commands in /cli) to confirm which plan is active and how much of the monthly credit allowance remains before running a large batch of calls.

Health and schema

  • Health check: a minimal liveness endpoint with no auth required.
  • Schema: a machine-readable catalog of current API and CLI capabilities, useful for an agent to discover what it can call without hardcoding a command list.

What’s out of scope here

Copilot chat, chart generation, and export are browser-session features, not part of this bearer-token API contract; they are not listed above. See /api/overview for the distinction between bearer-token endpoints and browser-session-only features.

Contract sources

For CLI commands that map onto these families, see /cli. For agent access over MCP instead of raw HTTP, see /agents/mcp.

Was this page helpful?