API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/keyword_ideas/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_ideas/live01
Input Schema
15 parameters · 1 required · 14 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
keywords | array | Required | keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and key... |
tag | string | Optional | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data ob... |
limit | integer | Optional | the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided ... |
filters | array | Optional | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators ar... |
order_by | array | Optional | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc R... |
offset_token | string | Optional | offset token for subsequent requests optional field provided 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 ... |
language_code | string | Optional | language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the... |
language_name | string | Optional | full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate re... |
location_code | integer | Optional | unique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with ... |
location_name | string | Optional | full name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with t... |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
closely_variants | boolean | Optional | search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: fa... |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keywo... |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if 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_ideas/live",
"prompt": "a beautiful sunset over mountains"
}'