API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/related_keywords/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/related_keywords/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 formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center articl... |
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... |
depth | integer | Optional | keyword search depthoptional fielddefault value: 1number of the returned results depends on the value you set in this fieldyou can specify a level from 0 to 4estimated number of keywords for each leve... |
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 ... |
language_code | string | Optional | language coderequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available locations with their language_c... |
language_name | string | Optional | full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available locations with thei... |
location_code | integer | Optional | location coderequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_c... |
location_name | string | Optional | full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with thei... |
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, ... |
replace_with_core_keyword | boolean | Optional | return data for core keywordoptional fieldif true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to;if false, serp_info and relat... |
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/related_keywords/live",
"prompt": "a beautiful sunset over mountains"
}'