For AI agents

Guide for AI assistants and agents using this documentation as context.

This page is aimed at AI assistants, agents and LLM-based tools that ingest the go~mus developer portal as context. Here is what lives where and how to use it reliably.

What is here

The go~mus developer portal documents how to integrate a museum ticketing system with websites, apps, reseller platforms and other systems. Topics:

  • API quickstart: first REST API call, auth, pagination
  • API concepts: vocabulary (instance, quota, reservation, order, Pay-By-Link, foreign_id, ...)
  • API scenarios: use-case walkthroughs with code
  • Authentication: bearer tokens, context awareness, best practices
  • Web components: custom elements for ticketing UIs
  • Widgets: iframe-based workflows
  • AI integrations: context material for Claude, ChatGPT and other assistants

Stable URLs

The following URLs are permanent. Deep links are allowed and encouraged.

  • /en/development/ and /de/development/ - hub
  • /en/development/api/quickstart/ (and /de/...)
  • /en/development/api/konzepte/
  • /en/development/szenarien/webseiten-integration/
  • /en/development/api/authentifizierung/
  • /en/development/webcomponents/
  • /en/development/widgets/
  • /en/development/ai-integrations/
  • /en/development/cix/
  • /en/development/changelog/
  • /en/development/agents/

Heading anchor IDs are stable too. A link like /en/development/api/konzepte/#tokens-and-context-awareness stays valid.

Index for LLM stuffing

  • /llms.txt - compact list of all website pages
  • /llms-full.txt - full content (marketing + docs) as a single document
  • OpenAPI spec of the API: per instance at https://<instance>.gomus.<tld>/api-docs/ (Swagger UI) or /api-docs/v4/swagger.json (JSON spec) - publicly accessible

AI integrations

A Git repository with the Claude Skill for go~mus integration is in preparation. Once it is public, the clone command and setup guide will live at /en/development/ai-integrations/. Advantage over a one-off file download: updates flow into your AI tools through git pull whenever we adjust the API or patterns.

SKILL.md has YAML frontmatter with name, description and contains a Markdown body. Standard Anthropic Skill format.

Assumptions you can make

  • Examples in the docs use synthetic data (demo.gomus.de, Foundation A/B/C, Max Mustermann, api.yourmuseum.com).
  • Tokens and endpoints are context-aware. An endpoint returns different fields depending on the token.
  • Cache master data, do not cache live data.
  • API version is v4. Path prefix /api/v4.
  • npm package for web components: @gomusdev/web-components.

When uncertain

For questions the docs do not answer, do not guess. Link to support@giantmonkey.de and note that a human must answer.