Skip to main content
POST
Keyword-ideas generate

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
seed
object
required

Exactly one seed mode: keywords, one page, both, or a whole site.

customer_id
string

Omit it: it defaults to the account this workspace is connected to, and any other account is refused.

geo_target_ids
string[]

Geo target IDs from adside google-ads geo-targets get. Strongly recommended; omitting them requests worldwide ideas.

Maximum array length: 10
Pattern: ^\d+$
language_id
string
default:1000

Language ID from adside google-ads languages get. Defaults to English (1000).

Pattern: ^\d+$
network
enum<string>
default:GOOGLE_SEARCH
Available options:
GOOGLE_SEARCH,
GOOGLE_SEARCH_AND_PARTNERS
include_adult_keywords
boolean
default:false
include_average_cpc
boolean
default:true
include_monthly_volumes
boolean
default:false

Show the monthly volume series returned for every idea.

page_size
integer
default:100

Ideas to return in this call. Deliberately capped below Google's 10,000-result limit to protect agent context.

Required range: 1 <= x <= 1000
page_token
string

Exact next-page token from a previous call. All other request fields must remain identical.

Minimum string length: 1

Response

200 - application/json

Success