Spideo API DOC
Documentation Powered by Redocly

Spideo API DOC (3.0.0)

Download OpenAPI specification:Download

Spideo's API offers a collection of endpoints that will allow you to integrate our services into your applications. The APIs are ready to deliver recommendations for Live TV, VoD, and Catch-up along with time-based features.

Authentication

APIKeyQueryParam

Security Scheme Type API Key
Query parameter name: apikey

TOPIC BASED SERVICES

Help people discover relevant content according to their topics of interest.

Find out more on spideo.tv

MOODBOARD

Make people discover content according to their moods

MOOD SEARCH

People can define their Mood by combining wishes. Display instantly the list of most relevant content items available according to people's moods. Visualize what wishes can be combined after every wish selection and the number of content items available behind every eligible next wish.

Authorizations:
APIKeyQueryParam
    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, or week.

    wishes
    required
    string

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

    query Parameters
    details
    boolean

    Display additional meta-data in addition to "content id" such as "titles" or "external ids". By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

    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

    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
    string

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

    catalogs
    string

    Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).

    distributions
    integer

    If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD

    platform
    integer

    This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.

    offer
    integer

    This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.

    territories
    string

    If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.

    lineups
    string

    This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.

    tabs
    string

    If your platform's interface is divided into separate sections or tabs for specific content 'groups', you can filter the recommendation for each section with this 'tab' parameter. In order to use this parameter, you must provide information about these specific content sections on your platform to Spideo beforehand and separate each tab by a comma (,).

    Responses

    Response samples

    Content type
    application/json
    {
    • "language": "en",
    • "contents": [
      ],
    • "wishes": [
      ],
    • "remainingWishes": [
      ]
    }

    MOOD LIST

    Display the list of wishes that can defining people's mood in all video universes, VOD, Catchup, linear TV. Get to know the number of titles connected to each mood and all wishes.

    Authorizations:
    APIKeyQueryParam
      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" - this universe is not available for testing, but it is available to implement "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'"

      query Parameters
      language
      string
      Enum: "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

      Responses

      Response samples

      Content type
      application/json
      {
      • "language": "en",
      • "size": 23,
      • "wishes": [
        ]
      }

      MOOD DETAILS

      Display one wish in any of the three main video universes, VOD, Catchup, linear TV, and visualize the number of titles connected to it.

      Authorizations:
      APIKeyQueryParam
        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, or week.

        wishes
        required
        string

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

        query Parameters
        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

        displaysize
        string

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

        catalogs
        string

        Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).

        distributions
        integer

        If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD

        platform
        integer

        This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.

        offers
        integer

        This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.

        territories
        string

        If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.

        lineups
        string

        This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.

        Responses

        Response samples

        Content type
        application/json
        {
        • "language": "en",
        • "size": 1,
        • "wishes": [
          ]
        }

        THEME BOARD

        Content discovery according to people's favorite themes

        THEME SEARCH

        Display the list of the most relevant content items in connection with any given selected themes, and define in which video universe (VOD, Catch up, linear TV) you want to perform this request. 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:
        APIKeyQueryParam
          path Parameters
          themes
          required
          string

          List of themes by id, separated by a comma (,). Example: 319

          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, or week.

          query Parameters
          details
          boolean

          Display additional meta-data in addition to "content id" such as "titles" or "external ids". By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

          language
          string
          Enum: "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

          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
          string

          Whether or not to display the total number of results. Default value: false

          catalogs
          string

          Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).

          distributions
          integer

          If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD

          platform
          integer

          This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.

          offers
          integer

          This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.

          territories
          string

          If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.

          lineups
          string

          This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.

          Responses

          Response samples

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

          THEME LIST

          Display the list of all available themes in the language of your choice. 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:
          APIKeyQueryParam
            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, or week.

            query Parameters
            details
            boolean

            Display additional meta-data in addition to "content id" such as "titles" or "external ids". By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

            Responses

            Response samples

            Content type
            application/json
            {
            • "size": 7,
            • "language": "en",
            • "themes": [
              ]
            }

            THEME DETAILS

            Display one theme in the video universe of your choice: VOD, Catch up, linear TV. Bear in mind that themes IDs are language dependent.

            Authorizations:
            APIKeyQueryParam
              path Parameters
              themes
              required
              string

              List of themes by id, separated by a comma (,). Example: 319

              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, or week.

              Responses

              Response samples

              Content type
              application/json
              {
              • "contentid": "MV007460750000",
              • "language": "en",
              • "size": 1,
              • "themes": [
                ]
              }

              SURPRISE

              Boost serendipity by making people discover topics they wouldn't have thought of themselves

              SURPRISE

              Automatically generate explainable thematic lists created by combinations of two keywords. Each pair of keywords is connected to a list of content corresponding to the combined topics.

              Authorizations:
              APIKeyQueryParam
                path Parameters
                universe
                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. Note: Surprise Me Features do not allow to carry out cross-universe recommendations. Therefore, for each Surprise Me feature, you must integrate a feature per universe.
                "Available universes are:" "vod" "catchup" - this universe is not available for testing, but it is available to implement
                "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'

                query Parameters
                limit
                integer

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

                details
                boolean

                Display additional meta-data in addition to "content id" such as "titles" or "external ids". By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".

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

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

                catalogs
                string

                Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).

                territories
                string

                If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.

                tabs
                string

                If your platform's interface is divided into separate sections or tabs for specific content 'groups', you can filter the recommendation for each section with this 'tab' parameter. In order to use this parameter, you must provide information about these specific content sections on your platform to Spideo beforehand and separate each tab by a comma (,).

                distributions
                integer

                If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD

                platform
                integer

                This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.

                offers
                integer

                This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.

                lineups
                string

                This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.

                Responses

                Response samples

                Content type
                {
                • "language": "en",
                • "content": "MV007460750000",
                • "pairs": [
                  ]
                }