Bornebiffen API (FastAPI)
This service now runs on FastAPI. Interactive documentation is available
via
/docs (Swagger UI) and
/redoc (ReDoc). These
views are powered by the OpenAPI schema generated from the same handlers
described below.
All endpoints enforce Pydantic validation; invalid inputs return HTTP 422
with a structured error payload.
General endpoints
- /health – lightweight readiness check
- /status – build information and statistics
- /metrics – Prometheus scrape endpoint
data
data
Returns data for movies.
Parameters:
-
id: id of movie to get data for. The parameter can be repeated
examples:
search
Search endpoint. Returns relevant ids found with query
Parameters:
- q: Query parameter
- start: Response offset. Default is 0
- rows: Number of returned rows. Default is 10
-
min_length: Minimum length of movies to include in results.
-
max_length: Maximum length of movies to include in results.
examples:
series
Series endpoint. Returns information about movies that are part of a
series with a given id
Parameters:
- series_id: id of series to get data for.
example:
image
Image endpoint. Provides images for a given movie in different formats.
Parameters:
- movie_id: id of movie to get image for.
-
resolution: required image resolution. Must be one of these:
image-landscape-169m, image-landscape-169s, image-landscape-169l.
example:
Recommend
Recommender endpoint. Returns relevant ids based on id
Parameters:
-
id: id of movie to base recommendations for. The parameter can be
repeated
-
min_length: Minimum length of movies to include in results.
-
max_length: Maximum length of movies to include in results.
example: /recommend?id=61730
example:
/recommend?id=61730&id=10275
example:
/recommend?id=61730&id=10275&min_length=5&max_length=20