API ключевых слов

Эндпоинты ключевых слов возвращают теги сюжета фильма или сериала, каждый в виде ID и названия. Можно получить одно ключевое слово, список фильмов с ним или передать ID в discover через with_keywords и собрать страницы тем. Фильмы отвечают в keywords, сериалы в results.

Обновлено Открыть в Markdown

Получение ключевых слов фильма

GET /3/movie/{movie_id}/keywords возвращает теги сюжета одного фильма. Ключевое слово представляет собой короткую фразу, например тему, место действия или тип первоисточника, и имеет числовой ID, который можно использовать в discover.

В примере загружаются ключевые слова фильма, после чего у discover запрашиваются самые популярные фильмы с первым из этих ключевых слов.

bashjspyphpgo
curl -s "https://api.amodb.dev/3/movie/550/keywords" \
  -H "Authorization: Bearer $AMODB_KEY"

curl -s "https://api.amodb.dev/3/discover/movie?with_keywords=818&sort_by=popularity.desc" \
  -H "Authorization: Bearer $AMODB_KEY"
const base = 'https://api.amodb.dev/3';
const headers = { Authorization: `Bearer ${process.env.AMODB_KEY}` };

const kw = await fetch(`${base}/movie/550/keywords`, { headers });
if (!kw.ok) throw new Error(`keywords failed with ${kw.status}`);
const { keywords } = await kw.json();
console.log(keywords.map((k) => `${k.id}:${k.name}`).join(', '));

if (keywords.length > 0) {
  const first = keywords[0];
  const found = await fetch(`${base}/discover/movie?with_keywords=${first.id}&sort_by=popularity.desc`, { headers });
  if (!found.ok) throw new Error(`discover failed with ${found.status}`);
  const page = await found.json();
  console.log(first.name, page.results.slice(0, 5).map((m) => m.title));
}
import os
import requests

base = "https://api.amodb.dev/3"
headers = {"Authorization": f"Bearer {os.environ['AMODB_KEY']}"}

r = requests.get(f"{base}/movie/550/keywords", headers=headers, timeout=10)
r.raise_for_status()
keywords = r.json()["keywords"]
print(", ".join(f"{k['id']}:{k['name']}" for k in keywords))

if keywords:
    first = keywords[0]
    d = requests.get(
        f"{base}/discover/movie",
        params={"with_keywords": first["id"], "sort_by": "popularity.desc"},
        headers=headers,
        timeout=10,
    )
    d.raise_for_status()
    print(first["name"], [m["title"] for m in d.json()["results"][:5]])
<?php
function amodb_get(string $url): array {
    $ch = curl_init($url);
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT => 10,
        CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AMODB_KEY')],
    ]);
    $body = curl_exec($ch);
    $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    if ($status !== 200) {
        throw new RuntimeException("amodb returned $status");
    }
    return json_decode($body, true);
}

$base = 'https://api.amodb.dev/3';
$keywords = amodb_get("$base/movie/550/keywords")['keywords'];
if ($keywords) {
    $first = $keywords[0];
    $found = amodb_get("$base/discover/movie?with_keywords={$first['id']}&sort_by=popularity.desc");
    $titles = array_column(array_slice($found['results'], 0, 5), 'title');
    echo $first['name'], ': ', implode(', ', $titles), PHP_EOL;
}
package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
	"time"
)

var client = &http.Client{Timeout: 10 * time.Second}

func get(path string, out any) error {
	req, _ := http.NewRequest("GET", "https://api.amodb.dev/3"+path, nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("AMODB_KEY"))
	res, err := client.Do(req)
	if err != nil {
		return err
	}
	defer res.Body.Close()
	if res.StatusCode != http.StatusOK {
		return fmt.Errorf("amodb returned %s", res.Status)
	}
	return json.NewDecoder(res.Body).Decode(out)
}

type Keywords struct {
	Keywords []struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
	} `json:"keywords"`
}

type Page struct {
	Results []struct {
		Title string `json:"title"`
	} `json:"results"`
}

func main() {
	var kw Keywords
	if err := get("/movie/550/keywords", &kw); err != nil {
		panic(err)
	}
	if len(kw.Keywords) == 0 {
		return
	}
	first := kw.Keywords[0]
	var page Page
	if err := get(fmt.Sprintf("/discover/movie?with_keywords=%d&sort_by=popularity.desc", first.ID), &page); err != nil {
		panic(err)
	}
	fmt.Println(first.Name)
	for i, m := range page.Results {
		if i == 5 {
			break
		}
		fmt.Println(" ", m.Title)
	}
}

Параметры

  • movie_idpathобязателен
    Числовой ID фильма, например 550.
  • api_keyqueryодин из двух
    Ваш ключ. Используйте его или заголовок Authorization: Bearer.

Поля ответа

ПолеТипПримечания
idцелое числоID фильма.
keywordsмассивОбъекты с id и name. Пуст, если у фильма нет ключевых слов.
keywords[].idцелое числоID ключевого слова. Используйте его в with_keywords и в путях ключевых слов ниже.
keywords[].nameстрокаТекст ключевого слова.

Пример ответа

JSON
{
  "id": 550,
  "keywords": [
    { "id": 818, "name": "based on novel or book" },
    { "id": 825, "name": "support group" },
    { "id": 851, "name": "dual identity" }
  ]
}

В реальном ответе 14 ключевых слов, здесь оставлены первые 3. Названия ключевых слов не переводятся, поэтому language на них не влияет.

Ключевые слова сериала

GET /3/tv/{series_id}/keywords принимает тот же ключ и возвращает такие же объекты, но массив называется results. В пути указывается ID сериала, например 1396.

JSON
{
  "id": 1396,
  "results": [
    { "id": 1508, "name": "new mexico" },
    { "id": 2231, "name": "drug dealer" }
  ]
}

В реальном ответе 29 записей, здесь оставлены первые 2. Клиент, который обслуживает оба типа медиа, может читать data.keywords ?? data.results и обрабатывать их одинаково.

Записи ключевых слов и их фильмы

Метод и путьВозвращаетПараметры
GET /keyword/{keyword_id}{ id, name }нет
GET /keyword/{keyword_id}/moviesПостраничный список фильмов с id, page, results, total_pages, total_resultslanguage, page

Оба пути используют числовой ID из массива ключевых слов. Список фильмов имеет ту же структуру элементов, что и другие списки фильмов, включая genre_ids и poster_path, а наверху добавлен id ключевого слова. Параметр include_adult принимается и игнорируется. Страница за пределами total_pages возвращает пустой массив results. Списка сериалов для ключевого слова нет, поэтому для сериалов используйте /discover/tv?with_keywords=.

Объединение ключевых слов через discover

Для всего, что сложнее простого списка, фильтруйте в discover. Он сортирует, разбивает на страницы, объединяет ключевые слова с другими фильтрами и работает как с фильмами, так и с сериалами.

ЦельСтрока запроса
Фильмы с одним ключевым словом/discover/movie?with_keywords=818
Фильмы с обоими из двух ключевых слов/discover/movie?with_keywords=818,4565
Фильмы без ключевого слова/discover/movie?without_keywords=818
Сериалы с ключевым словом/discover/tv?with_keywords=9712
Сериалы с любым из двух ключевых слов/discover/tv?with_keywords=818%7C9712
Одно ключевое слово внутри жанра/discover/movie?with_keywords=818&with_genres=18

Запятая между ID означает «все из них». Чтобы подошел любой из них, поставьте между ID вертикальную черту, как в with_keywords=818|4565. Результаты discover кэшируются на edge в течение 30 минут.

Как найти ID ключевого слова

Чтобы превратить текст в ID, вызовите GET /3/search/keyword?query=heist. Он возвращает постраничный список пар id и name, по 20 на странице. Полный набор путей поиска описан на странице поиск. Поиск ключевого слова, которому ничего не соответствует, сейчас отвечает 500 с status_code 11 вместо пустого списка. Ответы поиска кэшируются на 10 минут, но каждый вызов все равно учитывается в вашем лимите запросов в минуту, поэтому в поле с подсказками задерживайте отправку запросов (debounce).

Ошибки

HTTPstatus_codeКогда
4017Ключ отсутствует или неверен.
40236Период тарифа закончился.
40434Нет ключевого слова с таким ID на /keyword/{keyword_id} и в его списке фильмов.
40537Вы использовали метод записи на пути ключевых слов.
42925Вы превысили лимит запросов в минуту. Подождите Retry-After секунд.
50011Запрос /search/keyword, которому ничего не соответствует.

Неизвестный ID фильма или сериала на путях ключевых слов не дает 404. Вы получите HTTP 200 с этим ID и пустым массивом.

Все коды описаны на странице ошибки, а лимиты тарифов на странице лимиты запросов.

Практические советы

  • Храните id ключевого слова, а не название. Название могут переформулировать, а ID не меняется.
  • Списки ключевых слов кэшируются вместе с деталями тайтла на 6 часов. Для страниц с тегами достаточно обновлять их раз в неделю.
  • У одного тайтла короткий список тегов. Для страниц тем начинайте с ID ключевого слова и получайте его тайтлы через discover, а не наоборот.
  • Используйте without_keywords, чтобы убрать лишнее, например тег, который не должен попадать на семейную страницу.
  • Для малоизвестных тайтлов пустой массив является корректным ответом. Скройте строку с тегами, а не показывайте ошибку.