Official vendor OpenAPI document · agent-readyMediaVideo ProcessingapiKey, bearer, oauth278 EndpointsREST
For Agents
Add questions and interactions to Mindstamp videos, create personalized viewer links, and pull views, responses, and insights, plus transcripts and translation dubs.
Use for: Add a multiple choice question at 45 seconds into our onboarding video, Create a personalized link for jane@example.com to the sales demo, List all views of the product tour from last week, Get the responses to the quiz question in this video
Not supported: Does not stream live video, edit video footage, or host a general video CDN. Use for interactive video questions, viewer analytics, personalization, and dubbing in Mindstamp only.
The Mindstamp API builds and measures interactive videos: it adds questions, buttons, hotspots, and other interactions to a video and reports who watched and how they responded. You can create videos from an uploaded key or link existing Vimeo, Wistia, Loom, HeyGen, or Synthesia videos, edit their design, and organise them into groups and series with invite-only access lists. Viewer data covers views, interactions, responses, and weekly or monthly view summaries, and personalized links tie a view to a named viewer or custom_id. It also runs transcripts and translation dubs, with a quote step before a dub job starts.
Install Jentic One Beta
Connect the Mindstamp API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Mindstamp API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmindstamp.io%2Fmindstamp" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fmindstamp.io%2Fmindstamp" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Mindstamp API.
Add a question to a video at a given time with a prompt, answers, and actions such as jump, link, or email
Place interactions of type button, image, text, hotspot, redirect, or pause on a video timeline
Create a personalized link for a viewer with name, email, or custom_id and switch it active or inactive
List views filtered by video_id, group_id, series_id, viewer_email, or tags, and read each view's interactions
Read the responses to a single interaction to see how viewers answered a question
Quote and start a translation dub for a video with target_languages and a full_dub or text_only mode
Group videos into groups and series and invite viewers by email
Use Cases
Patterns agents use Mindstamp API for, with concrete tasks.
★ Agent-built interactive training videos through Jentic
An agent preparing a training module can turn a plain video into a quiz. Through Jentic it finds the Mindstamp question-create operation, adds questions at the right timestamps with a prompt and answers, and later reads each interaction's responses to report who answered correctly. Your Mindstamp token stays on your own Jentic One instance, and your rules can let the agent add questions without letting it delete videos.
POST /interactions/question/create with video_id 'vid_123', type set to a question type, time 45, prompt 'Which plan includes SSO?', and answers 'Starter,Pro,Enterprise', then GET /interactions/{id}/responses after the cohort has watched
Personalized sales videos and lead capture
Sales teams can send each prospect a personalized link with their name, email, and a custom_id from the CRM, so every view and interaction is tied to that person. Views can then be filtered by is_lead or viewer_email to find engaged prospects, and question answers can map to HubSpot fields through hubspot_field.
POST /plinks/create with video_id 'vid_123', name 'Jane Doe', email 'jane@example.com', custom_id 'crm-8841', then GET /views with viewer_email 'jane@example.com'
Translating videos for new markets
To localise a video, request a quote with target_languages first, then start the dub job with a mode of full_dub or text_only, optional source_language, voice_number, glossary_terms, and translate_interactions to carry questions across. Dub jobs can be read, retried, or cancelled, and a single failed language track can be retried on its own.
POST /videos/vid_123/dubs/quote with target_languages ['es','de'], then POST /videos/vid_123/dubs with mode 'full_dub', the same target_languages, and translate_interactions true
Engagement reporting
Marketing and learning teams can report on engagement without exporting from the dashboard. Insights are available per video, series, group, or tag over a start and finish window, and view summaries come in weekly and monthly forms.
GET /insights with series_id 'ser_42', start '2026-10-01', finish '2026-10-31', then GET /views/summary/month
Key Endpoints
78 endpoints — the mindstamp api builds and measures interactive videos: it adds questions, buttons, hotspots, and other interactions to a video and reports who watched and how they responded.
METHOD
PATH
DESCRIPTION
POST
/interactions/question/create
Create a question
POST
/interactions/create
Create an interaction
GET
/views
Get a list of views
GET
/interactions/{id}/responses
Get responses to an interaction
POST
/plinks/create
Create a personalized link
POST
/videos/{id}/dubs
Create a translation job
GET
/insights
Get insights
POST
/videos/create
Create a video
POST
/interactions/question/create
Create a question
POST
/interactions/create
Create an interaction
GET
/views
Get a list of views
GET
/interactions/{id}/responses
Get responses to an interaction
POST
/plinks/create
Create a personalized link
POST
/videos/{id}/dubs
Create a translation job
GET
/insights
Get insights
POST
/videos/create
Create a video
Jentic AI Readiness Score
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.
M
Mindstamp API
- Foundational (D+)50/100
48
Foundational Compliance73
Developer Experience & Jentic Compatibility26
AI-Readiness & Agent Experience89
Agent Usability67
Security79
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
48
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: D+Signals: 4
92%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
73
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
17%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
75%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
26
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
41%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
12%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
53%
Summary Coverage
Coverage of summaries across operations/tags/info.
89
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: ASignals: 1
89%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
67
Security
Trust, risk posture, and security compliance.
Grade: BSignals: 1
67%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
79
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
79%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Mindstamp by hand means choosing between a bearer API token and OAuth 2.1 with PKCE, and sending most create and update fields as query parameters. Through Jentic you install once, import Mindstamp from the API Directory, store the token once, and your agent calls it.
Permission scoping
Mindstamp puts the video, group, series, and view ids in the URL path (/videos/{id}/..., /groups/{id}/...), so a rule can pin your agent to one video or series and the operations you pick. You choose the operations it may call, so destructive ones like video deletion or access-list entry removal are not included unless you add them.
Credential isolation
Your Mindstamp token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'add a quiz question to a video' or 'list views of a video', and Jentic returns the matching Mindstamp operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Mindstamp API through Jentic.
What authentication does the Mindstamp API use?
Per its OpenAPI spec, the Mindstamp API declares three schemes that the operations accept: an API token sent as `Authorization: Bearer <token>` (bearerAuth, tokens never expire), the same Authorization header described as an apiKey scheme (APIKeyHeader), and OAuth 2.1 authorization code with PKCE (oauth2, scope public) for agents and integrations. GET /status/me needs no auth. Through Jentic the token is stored encrypted by your own Jentic One instance and injected when the agent calls.
Can I see how viewers answered a question with the Mindstamp API?
Yes. GET /interactions/{id}/responses returns the responses to a single interaction, and GET /views/{id}/interactions or GET /viewers/{id}/interactions show the interactions tied to one view or one viewer. Use personalized links with an email or custom_id if you need responses tied to named people.
How do I add a question to a video through Jentic?
Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import the Mindstamp API from the directory, and store your API token. Your agent searches 'add a question to a Mindstamp video', gets POST /interactions/question/create with its schema, and sends the required video_id, type, time, and prompt. 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 Mindstamp API?
Yes. For example, allow POST /interactions/question/create and GET /videos/vid_123/interactions, so the agent can add and review questions on that one video but cannot delete videos, change access lists, or start paid translation jobs. Every call it makes is logged.
Is there a Mindstamp MCP server?
You don't need an MCP server to give your agent Mindstamp. 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 Mindstamp API?
The OpenAPI spec does not specify rate limits. Check the Mindstamp documentation at https://mindstamp.com for current limits.
Can I use videos hosted elsewhere with Mindstamp?
Yes. POST /videos/create requires a key and title and accepts IDs from other hosts, including vimeo_id, wistia_id, loom_id, heygen_id, synthesia_id, google_drive_id, panopto_id, and bunny_id, so you can add interactions to a video without re-uploading it.
GET STARTED