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

# Get search suggestions

> Get YouTube search suggestions (autocomplete).
Similar to the suggestions shown when typing in the YouTube search box.

Notes:
Suggestions vary by language and region
Typically returns 10-20 suggestions
Response is very fast (< 1 second)

<div className="inline-flex items-center gap-2 px-4 py-2 bg-yellow-50 dark:bg-yellow-900/20 border border-yellow-200 dark:border-yellow-800 rounded-lg">
  <span className="text-base">🪙</span>
  <span className="text-sm font-medium text-yellow-900 dark:text-yellow-100"><span className="font-semibold">3 credits</span><span className="text-yellow-700 dark:text-yellow-300 ml-1">per request</span></span>
</div>

## Copy for AI

<div className="my-6 rounded-xl border border-gray-200 bg-gray-50 p-5 dark:border-gray-800 dark:bg-gray-900/40">
  <div className="min-w-0">
    <p className="text-base font-semibold text-gray-900 dark:text-gray-100">🤖 Why Code When AI Can Do It For You?</p>
    <p className="mt-1 text-sm text-gray-700 dark:text-gray-300">Stop writing code like it's 1970! Let AI do the heavy lifting - click the sparkles to copy a perfectly formatted prompt for ChatGPT, Claude, or your favorite AI assistant.</p>
  </div>

  <div className="mt-4">
    <button
      type="button"
      className="inline-flex items-center gap-2 rounded-md border border-emerald-300 bg-emerald-50 px-3 py-2 text-sm font-medium text-emerald-800 hover:bg-emerald-100 dark:border-emerald-700 dark:bg-emerald-900/30 dark:text-emerald-100 dark:hover:bg-emerald-900/50"
      onClick={() => navigator.clipboard.writeText(`I want to make an API call to https://api.keyapi.ai/v1/youtube/get_search_suggestions.

Please help me write code to make this API call and handle the response appropriately. Include error handling and best practices.

Here are the details:

Endpoint: GET https://api.keyapi.ai/v1/youtube/get_search_suggestions

Description: Get YouTube search suggestions (autocomplete).
Similar to the suggestions shown when typing in the YouTube search box.

Notes:
Suggestions vary by language and region
Typically returns 10-20 suggestions
Response is very fast (< 1 second)

Required Headers:
--header 'Authorization: Bearer <YOUR_API_KEY>'

Parameters:
- keyword (Required): Search keyword. Example: Rick Astley
- language (Optional): Language code (optional, default: en)
Options:
en: English
zh-cn: Simplified Chinese
ja: Japanese
ko: Korean. Example: en
- region (Optional): Region code (optional, default: US)
US: United States
SG: Singapore
CN: China
JP: Japan
KR: South Korea. Example: US

Example Response:
{
"code": 0,
"message": "success",
"data": {
"keyword": "Rick Astley",
"suggestions": [
  "rick astley never gonna give you up",
  "rick astley",
  "rick astley together forever",
  "rick astley pink pony club",
  "rick astley foo fighters",
  "rick astley never gonna give you up lyrics",
  "rick astley interview",
  "rick astley cry for help",
  "rick astley songs",
  "rick astley never gonna give you up live",
  "rick astley take me to your heart",
  "rick astley she wants to dance with me",
  "rick astley it would take a strong strong man",
  "rick astley whenever you need somebody"
],
"total_count": 14
},
"requestId": "aca97c0b-6216-4ba0-b502-df42fb0da1d7"
}`)}
    >
      <span>✨</span>
      <span>Copy for AI</span>
    </button>
  </div>
</div>


## OpenAPI

````yaml en/youtube.openapi.json GET /v1/youtube/get_search_suggestions
openapi: 3.0.1
info:
  title: YouTube API english document
  description: >-
    The english reference documentation of the YouTube API includes the
    interface's purpose, parameter description, response status, and sample
    structure.
  version: 1.0.0
servers:
  - url: https://api.keyapi.ai
    description: Production
security: []
tags: []
paths:
  /v1/youtube/get_search_suggestions:
    get:
      tags: []
      summary: Get search suggestions
      description: |-
        Get YouTube search suggestions (autocomplete).
        Similar to the suggestions shown when typing in the YouTube search box.

        Notes:
        Suggestions vary by language and region
        Typically returns 10-20 suggestions
        Response is very fast (< 1 second)
      parameters:
        - name: keyword
          in: query
          description: Search keyword
          required: true
          example: Rick Astley
          schema:
            type: string
            example: Rick Astley
        - name: language
          in: query
          description: |-
            Language code (optional, default: en)
            Options:
            en: English
            zh-cn: Simplified Chinese
            ja: Japanese
            ko: Korean
          required: false
          example: en
          schema:
            type: string
            default: en
        - name: region
          in: query
          description: |-
            Region code (optional, default: US)
            US: United States
            SG: Singapore
            CN: China
            JP: Japan
            KR: South Korea
          required: false
          example: US
          schema:
            type: string
            default: US
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example:
                code: 0
                message: success
                data:
                  keyword: Rick Astley
                  suggestions:
                    - rick astley never gonna give you up
                    - rick astley
                    - rick astley together forever
                    - rick astley pink pony club
                    - rick astley foo fighters
                    - rick astley never gonna give you up lyrics
                    - rick astley interview
                    - rick astley cry for help
                    - rick astley songs
                    - rick astley never gonna give you up live
                    - rick astley take me to your heart
                    - rick astley she wants to dance with me
                    - rick astley it would take a strong strong man
                    - rick astley whenever you need somebody
                  total_count: 14
                requestId: aca97c0b-6216-4ba0-b502-df42fb0da1d7
          headers: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 400
                  data: null
                  message: 'Missing required parameter: handle'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 401
                  data: null
                  message: apiKey is null
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 402
                  data: null
                  message: apiKey quota is not enough
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 429
                  data: null
                  message: qps limit exceeded
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 500
                  data: null
                  message: Internal server error
      deprecated: false
      security:
        - JWT Bearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.keyapi.ai/v1/youtube/get_search_suggestions?keyword=Rick+Astley&language=en&region=US' \
              --header 'Authorization: Bearer <YOUR_API_KEY>'
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                'https://api.keyapi.ai/v1/youtube/get_search_suggestions',
                params={"keyword": "Rick Astley", "language": "en", "region": "US"},
                headers={'Authorization': 'Bearer <YOUR_API_KEY>'}
            )
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const params = new URLSearchParams({"keyword": "Rick Astley",
            "language": "en", "region": "US"});


            const response = await
            fetch(`https://api.keyapi.ai/v1/youtube/get_search_suggestions?${params}`,
            {
              method: 'GET',
              headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
            });

            const data = await response.json();

            console.log(data);
components:
  securitySchemes:
    JWT Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |-
        API key for authentication. Format: `sk_live_xxxxxxxxxxxxx`
        Get your API key from the [Dashboard](http://keyapi.ai/app/dashboard).

````