Community OpenAPI document · agent-readyAnalyticsWeb Analyticsbasic42 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically poll whether an authentication request was confirmed, start an authentication request. Covers 42 operations with basic authentication.
Use for: I need to poll whether an authentication request was confirmed, I want to start an authentication request, Search for validate your authentication credentials, Find all mark episodes as acquired or watched based on their ids
Not supported: Does not handle payments, communications, or crm - use for analytics only.
Access to the user API is only possible for users with a [premium](http://www.tvmaze.com/premium) account. A user can only access their own user data. Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key can be found on your [dashboard](http://www.tvmaze.com/dashboard). To try out these API calls from th. The API exposes 42 endpoints secured with basic authentication.
Install Jentic One Beta
Connect the TVmaze user API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the TVmaze user 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%2Ftvmaze.com%2Ftvmaze-user-api" | 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%2Ftvmaze.com%2Ftvmaze-user-api" | 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 TVmaze user API.
Poll whether an authentication request was confirmed
Start an authentication request
Validate your authentication credentials
Mark episodes as acquired or watched based on their IDs
List watched and acquired episodes for a show
Use Cases
Patterns agents use TVmaze user API for, with concrete tasks.
★ Analytics Operations
Use the TVmaze user API to perform analytics operations programmatically. The API provides 42 endpoints covering core functionality including poll whether an authentication request was confirmed, start an authentication request, validate your authentication credentials.
Call POST /auth/poll to poll whether an authentication request was confirmed
Automated auth Management
Automate auth operations by combining multiple TVmaze user API endpoints. Agents can start an authentication request and then validate your authentication credentials in a single workflow.
Call POST /auth/start to start an authentication request, then verify the result
AI Agent Integration via Jentic
AI agents discover and call TVmaze user API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.
Search Jentic for 'poll whether an authentication request was confirmed', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
42 endpoints — access to the user api is only possible for users with a [premium](http://www.
METHOD
PATH
DESCRIPTION
POST
/auth/poll
Poll whether an authentication request was confirmed
POST
/auth/start
Start an authentication request
GET
/auth/validate
Validate your authentication credentials
POST
/scrobble/episodes
Mark episodes as acquired or watched based on their IDs
PUT
/scrobble/episodes/{episode_id}
Mark an episode as acquired or watched based on its ID
POST
/scrobble/shows
Mark episodes within a show as acquired or watched based on their attributes
GET
/scrobble/shows/{show_id}
List watched and acquired episodes for a show
GET
/user/episodes
List the marked episodes
POST
/auth/poll
Poll whether an authentication request was confirmed
POST
/auth/start
Start an authentication request
GET
/auth/validate
Validate your authentication credentials
POST
/scrobble/episodes
Mark episodes as acquired or watched based on their IDs
PUT
/scrobble/episodes/{episode_id}
Mark an episode as acquired or watched based on its ID
POST
/scrobble/shows
Mark episodes within a show as acquired or watched based on their attributes
GET
/scrobble/shows/{show_id}
List watched and acquired episodes for a show
GET
/user/episodes
List the marked episodes
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.
T
TVmaze user API
- Foundational (D-)41/100
80
Foundational Compliance61
Developer Experience & Jentic Compatibility54
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
80
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
21%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
61
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
45%
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.
54
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
54%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
63%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
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 TVmaze user API by hand means learning its basic user-token auth, running its start-and-poll authentication flow, and handling errors and retries yourself. Through Jentic you install once, import TVmaze user API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
TVmaze user API drives authentication and scrobbling through operations that carry their target in the request body or as episode and show ids, so scoping is operations-only: you limit the agent to the operations it needs, such as scrobbling episodes or reading followed shows, and leave out anything else. Every operation the agent can run is one you put in that allowed set.
Credential isolation
Your TVmaze user API 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.
Intent-based discovery
Agents search Jentic by intent such as 'start an authentication request' or 'scrobble a watched episode', and Jentic returns the matching TVmaze user API 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 TVmaze user API through Jentic.
What authentication does the TVmaze user API use?
The TVmaze user API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I poll whether an authentication request was confirmed with the TVmaze user API?
Yes. Use the POST /auth/poll endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the TVmaze user API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I poll whether an authentication request was confirmed through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'poll whether an authentication request was confirmed'. Jentic returns the matching TVmaze user API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the TVmaze user API have?
The TVmaze user API exposes 42 endpoints covering auth, followed networks, followed people operations.
Can I limit what my agent is allowed to do with the TVmaze user API?
Yes. Because you run Jentic One yourself, your own rules decide which TVmaze user API operations the agent may call and which stored credentials it may use. Scoping here is operations-only: you add just the operations the agent needs, such as scrobbling episodes with POST /scrobble/episodes or reading followed shows, and leave everything else out of the allowed set. Any authentication or scrobbling operation the agent can run is one you explicitly permitted.
GET STARTED