API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/keyword_suggestions/live
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
dataforseo/v3/dataforseo_labs/google/keyword_suggestions/live01
Input Schema
16 parameters · 1 required · 15 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
keyword | string | Required | keywordrequired fieldUTF-8 encodingthe keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center artic... |
tag | string | Optional | user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object... |
limit | integer | Optional | the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for... |
filters | array | Optional | array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are su... |
order_by | array | Optional | results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will ... |
exact_match | boolean | Optional | search for the exact phraseoptional fieldif set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrasedefault valu... |
offset_token | string | Optional | offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a s... |
language_code | string | Optional | language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehtt... |
language_name | string | Optional | full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate reque... |
location_code | integer | Optional | location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to thehtt... |
location_name | string | Optional | full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate reque... |
ignore_synonyms | boolean | Optional | ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false |
include_serp_info | boolean | Optional | include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword... |
include_seed_keyword | boolean | Optional | include data for the seed keywordoptional fieldif set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the responsedefault value: fa... |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, ... |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "dataforseo/v3/dataforseo_labs/google/keyword_suggestions/live",
"prompt": "a beautiful sunset over mountains"
}'