> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zilodata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search suggestions

> Get search suggestions based on keyword input



## OpenAPI

````yaml api-reference/spotify-openapi.json get /api/v1/suggestions
openapi: 3.1.0
info:
  title: Spotify APIs
  description: Spotify API Documentation
  version: 1.0.0
servers:
  - url: https://spotify-api31.p.rapidapi.com
security: []
paths:
  /api/v1/suggestions:
    get:
      tags:
        - Explore
      summary: Search suggestions
      description: Get search suggestions based on keyword input
      operationId: getApiV1Suggestions
      parameters:
        - in: query
          name: keyword
          schema:
            type: string
            description: Search keyword for suggestions
            example: despati
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Success
                  statusCode:
                    type: number
                    example: 200
                  pagination:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 100
                      hasMore:
                        type: boolean
                        example: true
                      continuation:
                        type:
                          - string
                          - 'null'
                        description: Continuation token for pagination
                        example: CDsQ8FsiEwje95_F1pmRAxXlsykDHUX
                  data:
                    type: object
                    properties:
                      suggestions:
                        type: array
                        items:
                          anyOf:
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: text
                                  description: Type of suggestion result
                                  example: text
                                suggestion:
                                  type: string
                                  description: Suggested search term
                                  example: despacito justin bieber
                                uri:
                                  type: string
                                  description: Spotify search URI
                                  example: spotify:search:despacito+justin+bieber
                              required:
                                - type
                                - suggestion
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: track
                                  description: Type of suggestion result
                                  example: track
                                id:
                                  type: string
                                  description: Track ID
                                  example: 6habFhsOp2NvshLv26DqMb
                                name:
                                  type: string
                                  description: Track name
                                  example: Despacito
                                uri:
                                  type: string
                                  description: Spotify track URI
                                  example: spotify:track:6habFhsOp2NvshLv26DqMb
                                duration:
                                  type: number
                                  description: Track duration in milliseconds
                                  example: 229360
                                artists:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        description: Artist name
                                        example: Luis Fonsi
                                      uri:
                                        type: string
                                        description: Spotify artist URI
                                        example: spotify:artist:4V8Sr092TqfHkfAA5fXXqG
                                    required:
                                      - name
                                      - uri
                                  description: Array of artists for this track
                                album:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      description: Album ID
                                      example: 5C0YLr4OoRGFDaqdMQmkeH
                                    name:
                                      type: string
                                      description: Album name
                                      example: VIDA
                                    uri:
                                      type: string
                                      description: Spotify album URI
                                      example: spotify:album:5C0YLr4OoRGFDaqdMQmkeH
                                    coverArt:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            description: Album cover image URL
                                            example: >-
                                              https://i.scdn.co/image/ab67616d00001e02ef0d4234e1a645740f77d59c
                                          width:
                                            type: number
                                            description: Image width in pixels
                                            example: 300
                                          height:
                                            type: number
                                            description: Image height in pixels
                                            example: 300
                                        required:
                                          - url
                                          - width
                                          - height
                                      description: Array of album cover images
                                  required:
                                    - id
                                    - name
                                    - uri
                                  description: Album information for this track
                                playability:
                                  type: object
                                  properties:
                                    playable:
                                      type: boolean
                                      description: Whether the track is playable
                                      example: true
                                    reason:
                                      type: string
                                      description: Playability reason
                                      example: PLAYABLE
                                  required:
                                    - playable
                                    - reason
                                  description: Track playability information
                              required:
                                - type
                                - id
                                - name
                                - uri
                                - duration
                                - artists
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: album
                                  description: Type of suggestion result
                                  example: album
                                id:
                                  type: string
                                  description: Album ID
                                  example: 3Gq2Dme9nesdgoqNNlcN8O
                                name:
                                  type: string
                                  description: Album name
                                  example: Despacito Feat. Justin Bieber (Remix)
                                uri:
                                  type: string
                                  description: Spotify album URI
                                  example: spotify:album:3Gq2Dme9nesdgoqNNlcN8O
                                artists:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        description: Artist name
                                        example: Luis Fonsi
                                      uri:
                                        type: string
                                        description: Spotify artist URI
                                        example: spotify:artist:4V8Sr092TqfHkfAA5fXXqG
                                    required:
                                      - name
                                      - uri
                                  description: Array of artists for this album
                                coverArt:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: Album cover image URL
                                        example: >-
                                          https://i.scdn.co/image/ab67616d00001e02ef0d4234e1a645740f77d59c
                                      width:
                                        type: number
                                        description: Image width in pixels
                                        example: 300
                                      height:
                                        type: number
                                        description: Image height in pixels
                                        example: 300
                                    required:
                                      - url
                                      - width
                                      - height
                                  description: Array of album cover images
                                date:
                                  type: object
                                  properties:
                                    year:
                                      type: number
                                      description: Release year
                                      example: 2017
                                  required:
                                    - year
                                  description: Release date information
                                typeAlbum:
                                  type: string
                                  description: Type of album (e.g., ALBUM, SINGLE)
                                  example: SINGLE
                                playability:
                                  type: object
                                  properties:
                                    playable:
                                      type: boolean
                                      description: Whether the album is playable
                                      example: true
                                    reason:
                                      type: string
                                      description: Playability reason
                                      example: PLAYABLE
                                  required:
                                    - playable
                                    - reason
                                  description: Album playability information
                              required:
                                - type
                                - id
                                - name
                                - uri
                                - artists
                                - coverArt
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: playlist
                                  description: Type of suggestion result
                                  example: playlist
                                id:
                                  type: string
                                  description: Playlist ID
                                  example: 6HlDxP4zJYtQOwe3XKrPOQ
                                name:
                                  type: string
                                  description: Playlist name
                                  example: >-
                                    O-Zone — Despre Tine - Original Album
                                    Version
                                uri:
                                  type: string
                                  description: Spotify playlist URI
                                  example: spotify:playlist:6HlDxP4zJYtQOwe3XKrPOQ
                                description:
                                  type: string
                                  description: Playlist description
                                  example: ''
                                images:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: Image URL
                                        example: >-
                                          https://i.scdn.co/image/ab67616d00001e0223aa56c8912f74c9ec97311c
                                      width:
                                        type:
                                          - number
                                          - 'null'
                                        description: Image width in pixels
                                        example: 640
                                      height:
                                        type:
                                          - number
                                          - 'null'
                                        description: Image height in pixels
                                        example: 640
                                    required:
                                      - url
                                      - width
                                      - height
                                  description: Array of playlist cover images
                                owner:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      description: Owner name
                                      example: 1Margarita4
                                    uri:
                                      type: string
                                      description: Spotify user URI
                                      example: spotify:user:3a21dhehyczbkbq2w3gx1nsd3
                                    username:
                                      type: string
                                      description: Owner username
                                      example: 3a21dhehyczbkbq2w3gx1nsd3
                                    avatar:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                            description: Image URL
                                            example: >-
                                              https://i.scdn.co/image/ab67616d00001e0223aa56c8912f74c9ec97311c
                                          width:
                                            type:
                                              - number
                                              - 'null'
                                            description: Image width in pixels
                                            example: 640
                                          height:
                                            type:
                                              - number
                                              - 'null'
                                            description: Image height in pixels
                                            example: 640
                                        required:
                                          - url
                                          - width
                                          - height
                                      description: Array of owner avatar images
                                  required:
                                    - name
                                    - uri
                                  description: Playlist owner information
                              required:
                                - type
                                - id
                                - name
                                - uri
                                - images
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: profile
                                  description: Type of suggestion result
                                  example: profile
                                id:
                                  type: string
                                  description: User ID
                                  example: 3a21dhehyczbkbq2w3gx1nsd3
                                displayName:
                                  type: string
                                  description: User display name
                                  example: 1Margarita4
                                username:
                                  type: string
                                  description: User username
                                  example: 3a21dhehyczbkbq2w3gx1nsd3
                                uri:
                                  type: string
                                  description: Spotify user URI
                                  example: spotify:user:3a21dhehyczbkbq2w3gx1nsd3
                                avatar:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: Image URL
                                        example: >-
                                          https://i.scdn.co/image/ab67616d00001e0223aa56c8912f74c9ec97311c
                                      width:
                                        type:
                                          - number
                                          - 'null'
                                        description: Image width in pixels
                                        example: 640
                                      height:
                                        type:
                                          - number
                                          - 'null'
                                        description: Image height in pixels
                                        example: 640
                                    required:
                                      - url
                                      - width
                                      - height
                                  description: Array of user avatar images
                              required:
                                - type
                                - id
                                - displayName
                                - uri
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: podcast
                                  description: Type of suggestion result
                                  example: podcast
                                id:
                                  type: string
                                  description: Podcast Show ID
                                  example: 7FevBPboXDSB4K90BJ54pA
                                name:
                                  type: string
                                  description: Podcast Show name
                                  example: 'Sleepy Stories: To help you sleep'
                                uri:
                                  type: string
                                  description: Spotify podcast show URI
                                  example: spotify:show:7FevBPboXDSB4K90BJ54pA
                                coverArt:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: Album cover image URL
                                        example: >-
                                          https://i.scdn.co/image/ab67616d00001e02ef0d4234e1a645740f77d59c
                                      width:
                                        type: number
                                        description: Image width in pixels
                                        example: 300
                                      height:
                                        type: number
                                        description: Image height in pixels
                                        example: 300
                                    required:
                                      - url
                                      - width
                                      - height
                                  description: Array of podcast show cover images
                                publisher:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      description: Publisher name
                                      example: Sleepy Studios
                                  required:
                                    - name
                                  description: Publisher information
                                topics:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        description: Topic title
                                        example: Culture
                                      uri:
                                        type: string
                                        description: Spotify genre URI
                                        example: spotify:genre:0JQ5DAqbMKFLFBJyefzcxG
                                    required:
                                      - title
                                      - uri
                                  description: Array of topics/genres for the podcast show
                              required:
                                - type
                                - id
                                - name
                                - uri
                                - coverArt
                            - type: object
                              properties:
                                type:
                                  type: string
                                  const: episode
                                  description: Type of suggestion result
                                  example: episode
                                id:
                                  type: string
                                  description: Episode ID
                                  example: 2oqoVIHDBWy1w2zs5kRp39
                                name:
                                  type: string
                                  description: Episode name
                                  example: '#37: ai cũng đi qua cơn giông của riêng mình'
                                uri:
                                  type: string
                                  description: Spotify episode URI
                                  example: spotify:episode:2oqoVIHDBWy1w2zs5kRp39
                                description:
                                  type: string
                                  description: Episode description
                                  example: Tập này buồn và khá nặng nề...
                                duration:
                                  type: number
                                  description: Episode duration in milliseconds
                                  example: 1554529
                                coverArt:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: Album cover image URL
                                        example: >-
                                          https://i.scdn.co/image/ab67616d00001e02ef0d4234e1a645740f77d59c
                                      width:
                                        type: number
                                        description: Image width in pixels
                                        example: 300
                                      height:
                                        type: number
                                        description: Image height in pixels
                                        example: 300
                                    required:
                                      - url
                                      - width
                                      - height
                                  description: Array of episode cover images
                                podcast:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      description: Podcast show ID
                                      example: 6vcyNclFEFyS2pVSKFEWJo
                                    name:
                                      type: string
                                      description: Podcast show name
                                      example: Vì sao thế nhỉ!
                                    uri:
                                      type: string
                                      description: Spotify podcast show URI
                                      example: spotify:show:6vcyNclFEFyS2pVSKFEWJo
                                  required:
                                    - id
                                    - name
                                    - uri
                                  description: Podcast show information
                              required:
                                - type
                                - id
                                - name
                                - uri
                                - duration
                                - coverArt
                        description: >-
                          Array of search suggestions (text, track, album,
                          playlist, profile, podcast, and episode results)
                        example:
                          - type: text
                            suggestion: despacito justin bieber
                            uri: spotify:search:despacito+justin+bieber
                          - type: text
                            suggestion: despacito
                            uri: spotify:search:despacito
                          - type: track
                            id: 6habFhsOp2NvshLv26DqMb
                            name: Despacito
                            uri: spotify:track:6habFhsOp2NvshLv26DqMb
                            duration: 229360
                            artists:
                              - name: Luis Fonsi
                                uri: spotify:artist:4V8Sr092TqfHkfAA5fXXqG
                          - type: album
                            id: 3Gq2Dme9nesdgoqNNlcN8O
                            name: Despacito Feat. Justin Bieber (Remix)
                            uri: spotify:album:3Gq2Dme9nesdgoqNNlcN8O
                            artists:
                              - name: Luis Fonsi
                                uri: spotify:artist:4V8Sr092TqfHkfAA5fXXqG
                            coverArt:
                              - url: >-
                                  https://i.scdn.co/image/ab67616d00001e02a6a335d613d151c626895a83
                                width: 300
                                height: 300
                    required:
                      - suggestions
                required:
                  - data
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Bad request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid API key
        '403':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: >-
                      You are not subscribed to this API, please subscribe
                      before using
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  status_code:
                    type: number
                    example: 500
                  cost:
                    type: number
                    example: 0
                  explain:
                    type: string
                    example: Internal Server Error
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-rapidapi-key
      description: API Key

````