Skip to content

TMDb Attributes

Filling in your TheMovieDb API key is mandatory in order to run Kometa.

A tmdb mapping is in the root of the config file, sampled below.

config.yml TMDb sample
tmdb:
  apikey: 147abc258def369ghi
  language: en
  region: US
  cache_expiration: 60
Attribute Description Allowed Values (default in bold) Required
apikey User TMDb V3 API key. Any valid API key
language ISO 639-1 code for user language. Two-letter ISO code, e.g. en
region ISO 3166-1 code for user region.
Used with TMDb Chart Builders.
Two-letter code or leave blank
cache_expiration Number of days before each cache mapping expires and is re-cached. Integer, e.g. 60

Important Notes

It is important that you use a TMDb V3 API key. If you do not already have one, follow the TMDb Getting Started guide.

If you would like to validate your API key valid prior to running Kometa, visit the TMDb Authentication page, sign in with your TMDb credentials and press the "Try It!" button on the right-hand side. You should see "success": true in the Response box.