canonical: https://jentic.com/apis/simkl.com/simkl

# Simkl API

Simkl API for accessing movie, TV show, and anime data. Provides search, ratings, watch history tracking, and recommendations. The API exposes 27 endpoints secured with apiKey, bearer authentication.

## For AI agents

Programmatically get pin for device authentication, check pin status. Covers 27 operations with apiKey, bearer authentication.

## Scope

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

## Capabilities

- Get PIN for device authentication
- Check PIN status
- Search movies
- Query and filter Simkl API records by parameters
- Monitor Simkl API operational status and events

## Use cases

### Analytics Operations

Use the Simkl API to perform analytics operations programmatically. The API provides 27 endpoints covering core functionality including get pin for device authentication, check pin status, get access token.

Example prompt: Call GET `/oauth/pin` to get pin for device authentication

### Automated Authentication Management

Automate authentication operations by combining multiple Simkl API endpoints. Agents can check pin status and then get access token in a single workflow.

Example prompt: Call GET `/oauth/pin/{user_code}` to check pin status, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Simkl 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 apiKey, bearer tokens manually.

Example prompt: Search Jentic for 'get pin for device authentication', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/oauth/pin` | Get PIN for device authentication |
| GET | `/oauth/pin/{user_code}` | Check PIN status |
| POST | `/oauth/token` | Get access token |
| GET | `/search/movie` | Search movies |
| GET | `/search/tv` | Search TV shows |
| GET | `/search/anime` | Search anime |
| GET | `/search/id` | Search by external ID |
| GET | `/movies/{id}` | Get movie details |

## Key resources

- **Authentication** — OAuth authentication endpoints
- **Search** — Search for movies, TV shows, and anime
- **Movies** — Movie information and trending
- **TV Shows** — TV show information and trending
- **Anime** — Anime information and trending

## 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:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 57 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 55 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/simkl.com/simkl/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 Simkl by hand means combining its simkl-api-key header with a bearer token from the device PIN flow and pointing calls at https://api.simkl.com. Through Jentic you install once, import Simkl from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Simkl search operations carry their query in the request path and query string, so limit the agent to the operations it needs, such as searching movies or looking up a title by id. You choose the operations it may call, so anything you do not add stays unavailable to the agent.
- **Credential handling:** Your Simkl api-key and token 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 'search for a movie' or 'look up a title by id', and Jentic returns the matching Simkl 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 Simkl API use?

The Simkl API uses apiKey, bearer authentication. 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 get pin for device authentication with the Simkl API?

Yes. Use the GET `/oauth/pin` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Simkl 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 get pin for device authentication through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get pin for device authentication'. Jentic returns the matching Simkl API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Simkl API have?

The Simkl API exposes 27 endpoints covering authentication, search, movies operations.

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

Yes. Because Jentic One is self-hosted, you decide which Simkl operations your agent may call and which credentials it may use. Simkl carries its queries in the request path and query string, so you can add only the operations you need, such as searching movies, TV shows, or anime, or looking up a title by external id, and leave everything else unavailable. Any operation you do not add, and the stored api-key and token behind it, stays out of the agent's reach.