canonical: https://jentic.com/apis/mindgame.eu/mindgame

# Mindgame LTPM API

The LTPM API is Mindgame's partner integration for LTP to give users access to Mindgame's game products and retrieve their usage data. A single sign-on call takes a user's uuid, the company, a language, a product_id, and callback and webhook URLs, and returns a game_link carrying a JWT that drops the user straight into the game. Partners can then read the play data for that uuid and product, including sessions, session_resume_requests, and play_status, reset a user's progress, or register a uuid with custom content for the 360 product.

## For AI agents

Generate single sign-on game links for Mindgame products, read a user's play data and status, and reset or register users through Mindgame's LTPM partner API.

## Scope

Does not create games, manage candidate pipelines, or score results beyond the play data it returns. Use for Mindgame SSO links, play data, resets, and 360 registration only.

## Capabilities

- Create a single sign-on game_link for a user by uuid, company, language, and product_id
- Pass callback_url and webhook_url with each SSO request so the partner is notified about the session
- Read a user's play data for a product, including sessions, session_resume_requests, and play_status
- Reset a user's progress on a product so they can start the game again
- Register a uuid for the 360 product with a custom object such as title, introduction, prompt, and start_text

## Use cases

### Agent-managed game invitations through Jentic

A partner platform's agent can invite users into a Mindgame product and follow up on their progress. Through Jentic it calls the SSO operation with the user's uuid, company, language, and product_id to get a game_link, sends that link to the user, and later reads play_status from the data operation. Your Mindgame basic-auth credentials stay on your own Jentic One instance.

Example prompt: POST /sso with uuid 'XXXXX-XXXXX-XXXXX-XXXXX', company 'CompanyX', language 'en', product_id 1, callback_url 'https://example.com/done', webhook_url 'https://example.com/hook', then send the returned game_link to the user

### Tracking completion and usage

Partners reporting on usage can read a user's play data per product. The data operation requires uuid, company, and product_id as query parameters and returns sessions, session_resume_requests, and a play_status such as not_played, so a dashboard or reminder flow can see who has not started yet.

Example prompt: GET /data with uuid 'XXXXX-XXXXX-XXXXX-XXXXX', company 'CompanyX', product_id 1 and send a reminder if play_status is 'not_played'

### Retakes and support requests

When a user's session breaks or a retake is approved, the reset operation clears that uuid's progress for one product and company. Because the reset is a GET call, it is worth keeping out of any automated flow that only needs to read data.

Example prompt: GET /reset with uuid 'XXXXX-XXXXX-XXXXX-XXXXX', company 'CompanyX', product_id 2 after a support agent approves the retake

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/sso` | Process SSO request and return game link |
| GET | `/data` | Return play data for a uuid |
| GET | `/reset` | Reset progress for a uuid |
| POST | `/register-360` | Register a uuid for 360 |

## Key resources

- **SSO** — Generate a JWT-carrying game link for a user and product
- **Play data** — Sessions, resume requests, and play status per user and product
- **Reset** — Clear a user's progress for a product
- **360 registration** — Register a user with custom content for the 360 product

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 31 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 69 / 100
  - AI-Readiness & Agent Experience: 19 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 56 / 100
- **View full report:** https://jentic.com/apis/mindgame.eu/mindgame/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the LTPM API by hand means sending basic-auth credentials, building SSO payloads with six required fields, and passing uuid, company, and product_id on every read. Through Jentic you install once, import the LTPM API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The LTPM API carries the user's uuid in the request body or query string, not the URL path, so rules bound which operations your agent may call, not which user. Limit the agent to the operations it needs, such as SSO and play data, so the reset operation is not included unless you add it.
- **Credential handling:** Your LTPM basic-auth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Mindgame game link' or 'check a user's play status', and Jentic returns the matching LTPM operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HackerRank API** — Coding tests and technical assessments
- **ClassMarker API** — Online quizzes and exam results
- **TalentLMS API** — Learning management for courses and users

## FAQ

### What authentication does the LTPM API use?

Per its OpenAPI spec, the LTPM API uses HTTP basic authentication (basicAuth) on each of its four operations, sending a username and password in the Authorization header. Through Jentic those credentials are stored encrypted by your own Jentic One instance and injected when the agent calls.

### What does the SSO operation return?

POST /sso returns a status, a message, and a data object with a game_link that carries a JWT, so the user can open the game without a separate login. All six body fields are required: uuid, company, language, product_id, callback_url, and webhook_url. The spec bounds product_id from 1 to 7.

### How do I check a user's play status through Jentic?

Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import the LTPM API from the directory, and store your basic-auth credentials. Your agent searches 'get Mindgame play data for a user', gets GET /data with its schema, and sends uuid, company, and product_id. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the LTPM API?

Yes. For example, allow only POST /sso and GET /data, so the agent can send game links and check progress but cannot call GET /reset and wipe a user's results. Every call it makes is logged.

### Is there a Mindgame MCP server?

You don't need an MCP server to give your agent the LTPM API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it.

### What are the rate limits for the LTPM API?

The OpenAPI spec does not specify rate limits. Check with Mindgame at https://mindgame.eu for current limits.