https://api.nexscope.ai/amazon/alexaSearchEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/amazon/alexaSearch |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
format | string | opcional | Response format: `markdown` returns a readable report; `json` returns a structured data array. Predeterminado: markdown |
prompts | array | obligatorio | 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]`. |
prompts[] | string | obligatorio | Una serie de diálogos indica con una longitud de 255 caracteres, sólo 1 es compatible; sólo 1 pregunta puede ser pasada en cada llamada. Cuando se hace a través de las veces, el agente necesita resumir el contexto de la ronda anterior y pasarlo como un nuevo `prompts[0]`. |
url | string | opcional | 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. |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (24 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
stdout | string | opcional | Informe de preguntas y respuestas en Markdown con la pregunta del usuario, la respuesta de Alexa, los productos recomendados y las preguntas de seguimiento de cada ronda; solo se devuelve cuando format=markdown |
data | array | opcional | Matriz de resultados de conversación estructurados; solo se devuelve cuando format=json |
resultsNum | integer | opcional | Número de rondas de conversación respondidas por Alexa; 0 indica que no se obtuvo una respuesta válida |
code | string | opcional | Código de estado de negocio: `"200"` indica éxito y equivale a la versión numérica de `errcode`. |
errcode | integer | opcional | Código de estado de negocio: `200` indica éxito. |
costTime | integer | opcional | Latencia de la API en milisegundos |
costToken | integer | opcional | Tokens consumidos por esta llamada; solo se cobra si el proveedor procesa la solicitud correctamente |
taskId | string | opcional | Identificador de tarea devuelto por el proveedor |
type | string | opcional | Estilo de presentación: stdoutWorkbenches (markdown) o json |
prompt | string | opcional | Pregunta enviada a Alexa en esta ronda |
content | string | opcional | Contenido de texto de la respuesta de Alexa en esta ronda |
screenshot | string | opcional | Enlace a la captura de pantalla de la conversación de esta ronda |
followUpQuestions | string[] | opcional | Lista de preguntas de seguimiento recomendadas por Alexa |
products | array | opcional | Lista de grupos de productos recomendados; cada grupo contiene title e items |
products[].title | string | opcional | Título del grupo recomendado |
products[].items[].asin | string | opcional | ASIN del producto |
products[].items[].title | string | opcional | Título del producto |
products[].items[].url | string | opcional | URL de la página de detalles del producto |
products[].items[].cover | string | opcional | URL de la imagen principal del producto |
products[].items[].price | string | opcional | Precio actual (con moneda) |
products[].items[].originalPrice | string | opcional | Precio original o tachado |
products[].items[].score | string | opcional | Valoración |
products[].items[].ratingsCount | string | opcional | Número de reseñas |
products[].items[].describe | string | opcional | Descripción del producto |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.