> ## Documentation Index > Fetch the complete documentation index at: https://dev-docs.trychainshift.ai/llms.txt > Use this file to discover all available pages before exploring further. # Google autocomplete suggestions > > **[BETA]** This is a beta API. The response spec may change without notice. Retrieves detailed (long-tail) Google keywords that contain the seed keyword, sorted by search volume in descending order. The seed keyword is excluded from the list, and its metrics are provided in the metrics field of the response. If the seed keyword has no search data, metrics is null. ### Errors | HTTP | Code | Description | | --- | --- | --- | | 400 | `COMMON_VALIDATION` | • keyword missing or longer than 80 characters • limit out of range (1 to 100) | | 400 | `KEYWORD_COUNTRY_NOT_SUPPORTED` | Unsupported country code | | 400 | `KEYWORD_METRICS_PROVIDER_REJECTED` | The provider rejected the request (language and country combination, keyword format) | | 401 | `COMMON_UNAUTHORIZED` | API key or access token is missing or invalid | | 402 | `INSUFFICIENT_CREDITS` | Organization credit balance is lower than the unit price of this request | | 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | Rate limit exceeded. Wait the number of seconds in the `Retry-After` header, then retry | | 500 | — | Internal server error. Returns `message` and `requestID` without `code` | | 502 | `KEYWORD_METRICS_PROVIDER_UNAVAILABLE` | Failed to call the metrics provider. Retry after a moment | | 503 | `KEYWORD_METRICS_NOT_CONFIGURED` | The keyword metrics feature is not enabled | ## OpenAPI ````yaml openapi.en.json GET /v1beta/platform/keywords/google/suggestions openapi: 3.1.0 info: description: >- Platform API for external partners. Uses organization API key based authentication. ### Common request limits - The request body size is limited to 2MiB. Exceeding it returns 413 with the `COMMON_REQUEST_BODY_TOO_LARGE` code. - Array parameters and string fields have per-endpoint count and length limits. The limits are stated in each field or parameter description, and violating them returns 400 with the `COMMON_VALIDATION` code. ### Error responses The error response body always has the same three fields regardless of the status code. | Field | Type | Meaning | | --- | --- | --- | | `code` | string | A fixed identifier for the error type. This is the only value clients should branch on. The codes each endpoint returns are listed in the "Errors" table of that API. | | `message` | string | A human-readable, one-line summary of the whole error. There is always exactly one. | | `details` | array of strings | Individual reasons that do not fit in the single `message` line. Even a single reason is returned as an array of length 1, and the field is omitted when there is nothing to include. | - `details` is an array in every error. It is never returned as a string or an object, so no type-based branching is needed. - The wording of `details` is not a fixed contract. Use it only for display and debugging, and do not parse the strings to branch. Branch on `code` instead. - `details` is the only field that carries multiple reasons. There is no `messages` field in the response. - On validation failure (`COMMON_VALIDATION`), `details` contains one `"field: reason"` line per violated field. Example: `{"code":"COMMON_VALIDATION","message":"Data validation failed","details":["keywords: up to 100 items can be entered"]}` - `message` defaults to Korean and is returned in English when you send `Accept-Language: en`. `details` follows the same rule when it carries per-field reasons such as validation failures, but errors that include raw text for diagnostic purposes may contain wording in a language other than the requested one. - Only 500 has a different shape. It returns `message` and a `requestID` to reference when contacting support, without `code`. title: Platform API version: '1.0' servers: - url: http://dev-platform-api.trychainshift.ai/api security: [] tags: - description: >- The top-level account unit that API keys belong to. Retrieve the organization's basic information. name: Organization - description: >- A target brand whose exposure in AI services is monitored. Provides brand registration, retrieval, update, and deletion. name: Brand - description: >- Keyword intelligence for analyzing brands and markets. Provides Google and Naver search metrics, related and autocomplete keyword lookups, and site URL based keyword analysis. name: Keyword (Beta) - description: >- A group that organizes prompts by purpose. Provides create, get, update, and delete operations for prompt sets. name: PromptSet - description: >- A sentence-level unit of a query sent to an AI service. Provides prompt create, get, update, and delete, plus bulk creation. name: Prompt - description: AI service models used for prompt runs. Lists the supported models. name: Model - description: The region used to run prompts. Retrieves the list of supported regions. name: Region - description: >- The unit of work that actually runs prompts against AI services. Provides prompt run requests and retrieval of progress status and lists. name: Run - description: >- An AI service response collected by a run. Retrieves answers including sources and search queries. name: Answer - description: >- Statistics on the sources cited in answers, at the domain and URL level. Retrieve the citation summary and per-domain and per-URL citation statistics. name: SourceStatistics (Beta) - description: >- Statistics on tokens (Kiwi nouns) in answer bodies. Retrieves a ranking of the most frequent tokens and the tokens near a specific word. name: AnswerStatistics (Beta) - description: >- Statistics on the search queries (fan-outs) the AI actually issued while generating answers. Retrieves a ranking of search queries by occurrence count. name: FanoutStatistics (Beta) - description: >- An auxiliary feature that identifies proper nouns in text. Provides proper noun extraction. name: ProperNoun (Beta) - description: >- Organization credit balance and Platform API billing information. Retrieves the current credit balance. name: Credit externalDocs: description: '' url: '' paths: /v1beta/platform/keywords/google/suggestions: get: tags: - Keyword (Beta) summary: Get Google keyword suggestions (autocomplete) description: >- > **[BETA]** This is a beta API. The response spec may change without notice. Retrieves detailed (long-tail) Google keywords that contain the seed keyword, sorted by search volume in descending order. The seed keyword is excluded from the list, and its metrics are provided in the metrics field of the response. If the seed keyword has no search data, metrics is null. ### Errors | HTTP | Code | Description | | --- | --- | --- | | 400 | `COMMON_VALIDATION` | • keyword missing or longer than 80 characters • limit out of range (1 to 100) | | 400 | `KEYWORD_COUNTRY_NOT_SUPPORTED` | Unsupported country code | | 400 | `KEYWORD_METRICS_PROVIDER_REJECTED` | The provider rejected the request (language and country combination, keyword format) | | 401 | `COMMON_UNAUTHORIZED` | API key or access token is missing or invalid | | 402 | `INSUFFICIENT_CREDITS` | Organization credit balance is lower than the unit price of this request | | 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | Rate limit exceeded. Wait the number of seconds in the `Retry-After` header, then retry | | 500 | — | Internal server error. Returns `message` and `requestID` without `code` | | 502 | `KEYWORD_METRICS_PROVIDER_UNAVAILABLE` | Failed to call the metrics provider. Retry after a moment | | 503 | `KEYWORD_METRICS_NOT_CONFIGURED` | The keyword metrics feature is not enabled | operationId: listGoogleKeywordSuggestions parameters: - description: Base keyword to look up detailed keywords for (up to 80 characters) example: protein powder in: query name: keyword required: true schema: type: string - description: Language code (ISO 639-1, default ko) example: en in: query name: languageCode schema: type: string - description: Country code (ISO 3166-1 alpha-2, default KR) example: US in: query name: countryCode schema: type: string - description: Maximum number of items to return (default 30, maximum 100) example: 50 in: query name: limit schema: type: integer responses: '200': content: application/json: schema: $ref: >- #/components/schemas/domain.ListGoogleKeywordSuggestionsResponse description: OK '400': content: application/json: schema: $ref: '#/components/schemas/domain.ValidationError' description: >- keyword missing or too long, limit out of range. See the error table above for country code and provider rejection errors '401': content: application/json: schema: $ref: '#/components/schemas/domain.UnauthorizedError' description: API key or access token is missing or invalid '402': content: application/json: schema: $ref: '#/components/schemas/domain.InsufficientCreditsError' description: >- The organization's credit balance is lower than the unit price of this request '429': content: application/json: schema: $ref: '#/components/schemas/domain.RateLimitExceededError' description: >- Rate limit exceeded. Wait the number of seconds in the Retry-After header, then retry '500': content: application/json: schema: $ref: '#/components/schemas/domain.InternalServerError' description: >- Internal server error. Include the requestID in your report so it can be traced '502': content: application/json: schema: $ref: '#/components/schemas/domain.KeywordProviderUnavailableError' description: Failed to call the metrics provider. Retry shortly '503': content: application/json: schema: $ref: '#/components/schemas/domain.KeywordMetricsNotConfiguredError' description: Keyword metrics feature is not enabled security: - OrgAPIKeyAuth: [] components: schemas: domain.ListGoogleKeywordSuggestionsResponse: properties: countryCode: description: Applied country code (with the default applied) example: US type: string keyword: description: Base keyword of the lookup (echoed) example: protein powder type: string languageCode: description: Applied language code (reflects the default) example: en type: string metrics: $ref: '#/components/schemas/domain.GoogleKeywordMetricsDTO' description: 기준 키워드 자신의 지표 (null = 데이터 없음) suggestedKeywords: description: >- Suggested keywords (descending by search volume, excluding the seed keyword) items: $ref: '#/components/schemas/domain.GoogleKeywordMetricsItemDTO' type: array uniqueItems: false required: - countryCode - keyword - languageCode - suggestedKeywords type: object domain.ValidationError: properties: code: description: Error code example: COMMON_VALIDATION type: string details: description: 'List of reasons per violating field (one "field: reason" per line)' example: - 'limit: must be 100 or less' items: type: string type: array uniqueItems: false message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Data validation failed type: string type: object domain.UnauthorizedError: properties: code: description: Error code example: COMMON_UNAUTHORIZED type: string message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Unauthenticated user type: string type: object domain.InsufficientCreditsError: properties: code: description: Error code example: INSUFFICIENT_CREDITS type: string message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Insufficient credits. type: string type: object domain.RateLimitExceededError: properties: code: description: Error code example: PLATFORM_RATE_LIMIT_EXCEEDED type: string message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Too many requests. Please try again later. type: string type: object domain.InternalServerError: properties: message: description: Error message (not localized) example: Internal Server Error type: string requestID: description: >- Request identifier to reference in support inquiries (same value as the X-Request-Id response header) example: bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk type: string type: object domain.KeywordProviderUnavailableError: properties: code: description: Error code example: KEYWORD_METRICS_PROVIDER_UNAVAILABLE type: string message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Failed to retrieve keyword metrics. Try again shortly type: string type: object domain.KeywordMetricsNotConfiguredError: properties: code: description: Error code example: KEYWORD_METRICS_NOT_CONFIGURED type: string message: description: >- Error message (Korean by default, English when Accept-Language: en is specified) example: Keyword metrics feature is not enabled yet type: string type: object domain.GoogleKeywordMetricsDTO: properties: cpc: description: Average cost per click (USD) example: 1.66 type: number keywordDifficulty: description: SEO difficulty (0 to 100) example: 32 type: integer monthlySearches: description: Monthly search volume for the last 12 months items: $ref: '#/components/schemas/domain.GoogleMonthlySearchDTO' type: array uniqueItems: false searchIntent: description: >- Search intent (informational | navigational | commercial | transactional) example: transactional type: string searchVolume: description: >- Average monthly search volume. null = search volume is not disclosed because of a restricted Google Ads category (medical, finance, etc.) example: 301000 type: integer searchVolumeTrend: $ref: '#/components/schemas/domain.GoogleSearchVolumeTrendDTO' description: Search volume change rate by period (%) type: object domain.GoogleKeywordMetricsItemDTO: properties: keyword: description: Keyword (exactly as in the request) example: protein powder type: string metrics: $ref: '#/components/schemas/domain.GoogleKeywordMetricsDTO' description: Search metrics (null = no data) required: - keyword type: object domain.GoogleMonthlySearchDTO: properties: month: description: Month (1 to 12) example: 6 type: integer searchVolume: description: Search volume for the month example: 450000 type: integer year: description: Year example: 2026 type: integer required: - month - year type: object domain.GoogleSearchVolumeTrendDTO: properties: monthly: description: Month-over-month change (%) example: -33 type: number quarterly: description: Quarter over quarter (%) example: 50 type: number yearly: description: Year over year (%) example: 50 type: number type: object securitySchemes: OrgAPIKeyAuth: description: '"Enter your organization API key. Example: ''cs_live_xxxx''"' in: header name: API-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.