canonical: https://jentic.com/apis/tvmaze.com/tvmaze-user-api

# TVmaze user API

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.

## For AI agents

Programmatically poll whether an authentication request was confirmed, start an authentication request. Covers 42 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for analytics only.

## Capabilities

- 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

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'poll whether an authentication request was confirmed', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| 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 |

## Key resources

- **auth** — Operations related to auth
- **followed networks** — Operations related to followed networks
- **followed people** — Operations related to followed people
- **followed shows** — Operations related to followed shows
- **followed webchannels** — Operations related to followed webchannels

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### 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.
