https://api.nexscope.ai/seo/aiSearchCitationSampleEjecutar 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/seo/aiSearchCitationSample |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
prompt | string | obligatorio | Valor de Prompt usado por esta operación de API. Longitud mínima: 1 Longitud máxima: 2000 |
Respuesta de ejemplo
Estructura de respuesta de ejemplo del contrato documentado de la API de SEO.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": "123",
"result": {
"answerMarkdown": "synthetic",
"checkUrl": "synthetic",
"citations": [
{
"domain": "synthetic",
"publishedAt": 9007199254740992,
"snippet": "synthetic",
"sourceName": "synthetic",
"title": "synthetic",
"url": "synthetic"
}
],
"meta": {
"market": {
"country": "synthetic",
"language": "synthetic",
"locationCode": 1
},
"missing": [
{
"path": "synthetic",
"reason": "synthetic"
}
],
"missingOverflow": false,
"retrievedAt": 9007199254740992,
"sampledAt": 9007199254740992,
"source": "synthetic",
"truncated": false
},
"model": "synthetic",
"prompt": "synthetic"
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": "0"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": "synthetic-trace",
"ts": "9007199254740993"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Permitidos: 0, 42008, 42009 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | opcional | Valor de Call id usado por esta operación de API. |
data.completedAt | string | integer | null | opcional | Valor de Completed at usado por esta operación de API. |
data.coverage | object | opcional | Valor de Coverage usado por esta operación de API. |
data.coverage.missing | array | opcional | Valor de Missing usado por esta operación de API. |
data.coverage.missing[] | object | obligatorio | Elemento de data coverage missing. |
data.coverage.missing[].field | string | opcional | Valor de Field usado por esta operación de API. |
data.coverage.missing[].reason | string | opcional | Valor de Reason usado por esta operación de API. |
data.coverage.status | string | opcional | Valor de Status usado por esta operación de API. |
data.requestedAt | string | integer | null | opcional | Valor de Requested at usado por esta operación de API. |
data.result | object | null | obligatorio | Valor de Result usado por esta operación de API. |
data.result.answerMarkdown | any | obligatorio | Valor de Answer markdown usado por esta operación de API. |
data.result.checkUrl | any | obligatorio | Valor de Check url usado por esta operación de API. |
data.result.citations | array | obligatorio | Valor de Citations usado por esta operación de API. Cantidad máxima de elementos: 50 |
data.result.citations[] | object | obligatorio | Elemento de data result citations. |
data.result.citations[].domain | any | obligatorio | Valor de Domain usado por esta operación de API. |
data.result.citations[].publishedAt | any | obligatorio | Valor de Published at usado por esta operación de API. |
data.result.citations[].snippet | any | obligatorio | Valor de Snippet usado por esta operación de API. |
data.result.citations[].sourceName | any | obligatorio | Valor de Source name usado por esta operación de API. |
data.result.citations[].title | any | obligatorio | Valor de Title usado por esta operación de API. |
data.result.citations[].url | any | obligatorio | Valor de Url usado por esta operación de API. |
data.result.meta | object | obligatorio | Valor de Meta usado por esta operación de API. |
data.result.meta.market | object | obligatorio | Valor de Market usado por esta operación de API. |
data.result.meta.market.country | string | obligatorio | Valor de Country usado por esta operación de API. Constante: US |
data.result.meta.market.language | string | obligatorio | Valor de Language usado por esta operación de API. Constante: en |
data.result.meta.market.locationCode | integer | obligatorio | Valor de Location code usado por esta operación de API. Constante: 2840 |
data.result.meta.missing | array | obligatorio | Valor de Missing usado por esta operación de API. Cantidad máxima de elementos: 100 |
data.result.meta.missing[] | object | obligatorio | Elemento de data result meta missing. |
data.result.meta.missing[].path | string | obligatorio | Valor de Path usado por esta operación de API. |
data.result.meta.missing[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. Permitidos: MISSING, NULL, INVALID, UNSUPPORTED, TRUNCATED |
data.result.meta.missingOverflow | boolean | obligatorio | Valor de Missing overflow usado por esta operación de API. |
data.result.meta.retrievedAt | any | obligatorio | Valor de Retrieved at usado por esta operación de API. |
data.result.meta.sampledAt | any | obligatorio | Valor de Sampled at usado por esta operación de API. |
data.result.meta.source | string | obligatorio | Valor de Source usado por esta operación de API. Constante: DATAFORSEO_CHATGPT_INTERFACE |
data.result.meta.truncated | boolean | obligatorio | Valor de Truncated usado por esta operación de API. |
data.result.model | any | obligatorio | Valor de Model usado por esta operación de API. |
data.result.prompt | string | obligatorio | Valor de Prompt usado por esta operación de API. Longitud máxima: 2000 |
data.schemaVersion | string | null | opcional | Valor de Schema version usado por esta operación de API. |
data.source | string | null | opcional | Valor de Source usado por esta operación de API. |
data.status | string | opcional | Valor de Status usado por esta operación de API. Permitidos: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | null | opcional | Valor de Usage usado por esta operación de API. |
data.usage.billingStatus | string | null | opcional | Valor de Billing status usado por esta operación de API. |
data.usage.chargedCredits | string | integer | null | opcional | Valor de Charged credits usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.answerMarkdown | string | obligatorio | Valor de Answer markdown usado por esta operación de API. Longitud máxima: 65536 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.answerMarkdown | null | obligatorio | Valor de Answer markdown usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.checkUrl | string | obligatorio | Valor de Check url usado por esta operación de API. Longitud máxima: 4096 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.checkUrl | null | obligatorio | Valor de Check url usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].domain | string | obligatorio | Valor de Domain usado por esta operación de API. Longitud máxima: 1024 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].domain | null | obligatorio | Valor de Domain usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].publishedAt | integer | obligatorio | Valor de Published at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].publishedAt | null | obligatorio | Valor de Published at usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].snippet | string | obligatorio | Valor de Snippet usado por esta operación de API. Longitud máxima: 8192 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].snippet | null | obligatorio | Valor de Snippet usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].sourceName | string | obligatorio | Valor de Source name usado por esta operación de API. Longitud máxima: 1024 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].sourceName | null | obligatorio | Valor de Source name usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].title | string | obligatorio | Valor de Title usado por esta operación de API. Longitud máxima: 1024 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].title | null | obligatorio | Valor de Title usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].url | string | obligatorio | Valor de Url usado por esta operación de API. Longitud máxima: 4096 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.citations[].url | null | obligatorio | Valor de Url usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.meta.retrievedAt | integer | obligatorio | Valor de Retrieved at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.meta.retrievedAt | null | obligatorio | Valor de Retrieved at usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.meta.sampledAt | integer | obligatorio | Valor de Sampled at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.meta.sampledAt | null | obligatorio | Valor de Sampled at usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.model | string | obligatorio | Valor de Model usado por esta operación de API. Longitud máxima: 1024 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.model | null | obligatorio | Valor de Model usado por esta operación de API. |
Respuesta de procesamiento aceptado
code 0 confirma la aceptación. Usa data.callId para consultar la misma solicitud; el procesamiento no implica finalización.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Constante: 0 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | obligatorio | Valor de Reason usado por esta operación de API. Constante: IN_PROGRESS |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | obligatorio | Valor de Status usado por esta operación de API. Constante: PROCESSING |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Respuesta de error
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | null | obligatorio | Valor de Reason usado por esta operación de API. |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | null | obligatorio | Valor de Status usado por esta operación de API. |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Obtener un resultado en procesamiento
Una respuesta conPROCESSING y un callIdsignifica que el resultado aún se está preparando. Usa la consulta de resultado siguiente con el identificador devuelto. Esta consulta lee el resultado guardado y no consume créditos.
curl -X GET https://api.nexscope.ai/seo/aiSearchCitationSample/calls/{callId} \
-H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"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 la ausencia de una clave API (code 11209), 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.