Recommend section of a track

GET 
/v0/tracks/:trackId/highlights

Powered by our 2 billion daily streams on YouTube, the highlights endpoint uses machine learning to recommend the best time section.

You can use highlights to start playing the track from the right millisecond, or recommend the right part of the track for shorter content.

The highlights endpoint provides start and stop timestamps in milliseconds. The default duration is 30 seconds.

The endpoint accepts up to 5 different durations per request where each duration must be at least 5 seconds and at most 60 seconds.

Request

Path Parameters

trackId stringrequired

Track id

Query Parameters

duration int32[]

The highlight duration in seconds

Responses

200

List of highlighted sections for the track. The times are given in milliseconds. If there is no available highlight, a fallback to the first section of the track is returned.

application/json

Schema

Schema

highlights

object[]

required

Array [

from int32required

to int32required

duration int32required

]

Example (from schema)

{
  "highlights": [
    {
      "from": 0,
      "to": 0,
      "duration": 0
    }
  ]
}

Example

{
  "highlights": [
    {
      "from": 9000,
      "to": 39000,
      "duration": 30
    }
  ]
}

400

Bad request.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Bad request"
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Invalid credentials"
}

404

Track was not found.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Track was not found"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Example

{
  "message": "Rate limit exceeded"
}

Loading...