https://api.nexscope.ai/amazon/alexaSearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazon/alexaSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
prompts | string[] | required | An array of dialogue prompts with a length within 255 characters, only 1 is supported; only 1 question can be passed in for each call. When asking across times, the agent needs to summarize the context of the previous round and pass it in as a new `prompts[0]`. |
format | string | optional | Response format: `markdown` returns a readable report; `json` returns a structured data array. Example: markdown |
url | string | optional | A specific category page, search results page, or product detail page URL that is used to supplement the Alexa page context; do not pass the Amazon homepage URL. |
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 (24 fields)
| Name | Type | Required | Description |
|---|---|---|---|
stdout | string | optional | Markdown format Q&A report, containing each round's user question, Alexa answer, recommended products, and follow-up questions; only returned when format=markdown |
data | array | optional | Structured conversation result array; only returned when format=json |
resultsNum | integer | optional | Number of conversation rounds Alexa actually answered; 0 means no valid response was produced |
code | string | optional | Business status code, successful is `"200"`, the same as the numerical version of `errcode`. |
errcode | integer | optional | Business status code, `200` indicates success. |
costTime | integer | optional | API latency in milliseconds |
costToken | integer | optional | Tokens consumed by this call; charged only if upstream succeeds |
taskId | string | optional | Task identifier returned by upstream |
type | string | optional | Render style: stdoutWorkbenches (markdown) or json |
prompt | string | optional | Prompt sent to Alexa for this round |
content | string | optional | Text content of Alexa's response for this round |
screenshot | string | optional | Screenshot link for this round's conversation |
followUpQuestions | string[] | optional | List of follow-up questions recommended by Alexa |
products | array | optional | Recommended product group list, each group containing title and items |
products[].title | string | optional | Recommended group title |
products[].items[].asin | string | optional | Product ASIN |
products[].items[].title | string | optional | Product title |
products[].items[].url | string | optional | Product detail page URL |
products[].items[].cover | string | optional | Product cover image URL |
products[].items[].price | string | optional | Current price (with currency) |
products[].items[].originalPrice | string | optional | Original or strikethrough price |
products[].items[].score | string | optional | Rating |
products[].items[].ratingsCount | string | optional | Review count |
products[].items[].describe | string | optional | Product description |
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.