Skip to content

Recommendation

create Search Overview

POST /api/recommendation/overviews/{collection}

Retained recommendation Worker adapter. Automatic retries are disabled. Maximum UTF-8 request body: 4096 bytes.

Markdown · Authoritative OpenAPI

Request policy

Operation
createSearchOverview
Access
anonymous
Automatic retries
None
Redirects
Returned to the caller without following
Request body limit
4096 UTF-8 bytes
Pagination
No collection iterator

Parameters

collection string required

Allowed: "videos" | "movies" | "music" | "podcasts"

Request body

application/json

object required

Schema details

query string required

category string

filters string[]

Schema details

string

canonicalIds string[] required

Schema details

string

totalCount number

Responses

200

Successful response

application/json

object

Schema details

status string required

Allowed: "found" | "empty"

query string required

summary string required

points object[] required

Schema details

object

Schema details

text string required

canonicalIds string[] required

Schema details

string

sources object[] required

Schema details

object

Schema details

canonicalId string required

title string required

canonicalUrl string required

description string required

category string required

year number required

metadata string[] required

Schema details

string

image object required

Schema details

object

Schema details

src string required

alt string required

unknown

actionUrl string required

scopeNotice string required

matchType string required

Allowed: "search-results" | "related"

400

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

403

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

413

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

429

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

502

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

503

Request failed

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

Examples

Examples use synthetic fixture values. Replace fixture identifiers with public IDs returned by the service. Request bodies and precise locations are transient; keep them out of logs.

curl

curl --fail-with-body --max-time 30 --max-filesize 16777216 --request POST 'https://irvinebroque.com/api/recommendation/overviews/videos' --header 'Accept: application/json' --header 'Content-Type: application/json' --data-binary @request.json

TypeScript

import { PublicApi } from '@irvinebroque/public-api';
const api = new PublicApi();
const result = await api.recommendation.overview({
  "collection": "videos",
  "body": {
    "query": "fixture",
    "canonicalIds": []
  }
});
console.log(result.status, result.headers.get('content-type')); // Keep transient capabilities in memory.

CLI

irvinebroque recommendation overview --collection 'videos' --body-file request.json

request.json

{
  "query": "fixture",
  "canonicalIds": []
}

The SDK preserves status, headers, and the server envelope. A 304 has no fresh body. Errors retain structured problem details; ordinary error messages omit response details. Responses are limited to 16 MiB and requests time out after 30 seconds by default.