SEARCH

SEARCH (3.0.0)

Download OpenAPI specification:Download

Provide the ability to find content by using semantics as precious guides in your discovery experience.

Authentication

APIKeyQueryParam

Security Scheme Type API Key
Query parameter name: apikey

SEARCH TEXT

Perform autocompleted text based search. Four types of results can be returned; 1) content titles (like Movie/TV Show titles) 2) stars (cast, directors, celebrities) 3) keywords (theme/mood) 4) related keywords (keywords hyperonyms)

Authorizations:
path Parameters
universes
required
Array of strings
Items Enum: "vod" "now" "today" "tonight" "later_tonight" "week"

This parameter defines the content universe in which we want to target content recommendations. If you want to call several universes, you have to separate each of them by a comma (,). "Available universes are:" "vod" "catchup" "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'"

text
required
string

Allows free text search. Results can contain movie title, tv show title, star name or Spideo semantic keywords.

query Parameters
types
Array of strings
Items Enum: "content" "keyword" "star"

Can be used if you want to have recommendations only on a specific type of content. Available types are; *content *keyword *star If you want to call several types of content, separate each of them by a comma (,)

Responses

Response samples

Content type
application/json
{
  • "search": "gang",
  • "contents":
    [
    ],
  • "stars":
    {
    },
  • "keywords":
    {
    }
}

SEMANTIC SEARCH

Perform advanced search of content by using Spideo's semantic keywords. Combine themes and wishes to return the most relevant content according to every user's mood. Bear in mind that themes IDs are language dependent. If you need to handle several languages, our team can provide tables of translations during the integration project.

Authorizations:
path Parameters
universes
required
Array of strings
Items Enum: "vod" "now" "today" "tonight" "later_tonight" "week"

This parameter defines the content universe in which we want to target content recommendations. If you want to call several universes, you have to separate each of them by a comma (,). "Available universes are:" "vod" "catchup" "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'"

query Parameters
themes
string

List of themes by id, separated by a comma (,)

wishes
string

List of wishes by id, separated by a comma (,)

genres
string

Filter the results according to one or several genres.

sections
string

If you want to restrict the recommendations to a specific section, you can pass the section code as a value to this parameter.

formattv
string

List of TV formats, separated by a comma (,). Available formats are;

language
string
Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th"

Language in which the metadata is displayed: *en - english (default) *fr - french *de - german *br - brazilian portuguese *es - spanish *id - indonesian *ms - malay *ph - filipino *th - thai

details
boolean

You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

skip
integer

For similar content content recommendations, you can use this parameter to skip the first results that would be displayed. For example; skip=5 means not showing the first 5 results. Default value=0

limit
integer

Number of results requested (max.100). The default value=10

displaysize
boolean

You can choose to display the total number of results by using "true". The default value= false

Responses

Response samples

Content type
application/json
{
  • "contents":
    [
    ],
  • "language": "en",
  • "themes":
    [
    ],
  • "sections": [ ],
  • "operation": "all"
}

CELEBRITY SEARCH

Perform search requests on a director's name, actress or actor's name and combine this name to help people discover content by celebrities' filmography.

Authorizations:
path Parameters
universes
required
Array of strings
Items Enum: "vod" "now" "today" "tonight" "later_tonight" "week"

This parameter defines the content universe in which we want to target content recommendations. If you want to call several universes, you have to separate each of them by a comma (,). "Available universes are:" "vod" "catchup" "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'"

query Parameters
themes
string

List of themes by id, separated by a comma (,)

wishes
string

List of wishes by id, separated by a comma (,)

genres
string

Filter the results according to one or several genres.

sections
string

If you want to restrict the recommendations to a specific section, you can pass the section code as a value to this parameter.

formattv
string

List of TV formats, separated by a comma (,). Available formats are;

stars
string

List of cast members by id, separated by a comma (,)

language
string
Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th"

Language in which the metadata is displayed: *en - english (default) *fr - french *de - german *br - brazilian portuguese *es - spanish *id - indonesian *ms - malay *ph - filipino *th - thai

details
boolean

You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

skip
integer

For similar content content recommendations, you can use this parameter to skip the first results that would be displayed. For example; skip=5 means not showing the first 5 results. Default value=0

limit
integer

Number of results requested (max.100). The default value=10

displaysize
boolean

You can choose to display the total number of results by using "true". The default value= false

Responses

Response samples

Content type
application/json
{
  • "contents":
    [
    ],
  • "language": "en",
  • "sections": [ ],
  • "operation": "all"
}