https://api.nexscope.ai/ai-search/googleSearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ai-search/googleSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Google search keywords as `q=` parameter to initiate Google AI Mode search. Only a single round of dialogue is supported; if you need to ask questions, the agent needs to summarize the key information of the previous round of AI overview and splice new questions, and then initiate a request as a new `keyword`. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (9 fields)
| Name | Type | Required | Description |
|---|---|---|---|
stdout | string | optional | AI overview text, in Markdown format; output the AI overview points and reference source links for each question paragraph by paragraph in order of questions. |
sourceUrl | string | optional | Crawl the target URL and eventually send it to Google's search page address. |
resultsNum | integer | optional | The number of AI overview blocks; greater than 0 means that the page renders AI Overview, and 0 means that the keyword does not trigger AI Overview. |
code | string | optional | Business status code, successful is `"200"`, corresponding to the numerical version of `errcode`. |
errcode | integer | optional | Business status code; `200` indicates success, other values indicate business errors. |
costTime | integer | optional | API latency in milliseconds |
costToken | integer | optional | This call consumes the number of Tokens; it will be billed only if the upstream returns successfully. |
taskId | string | optional | The identification of this crawling task returned by the upstream. |
type | string | optional | The rendering style, fixed to `stdoutWorkbenches`, is rendered in Markdown format with the `stdout` field. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.