| Punto de conexión | Devuelve |
|---|---|
/search | Resultados orgánicos web clasificados |
/scrape | Extrae contenido de la URL |
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
query | cadena | Sí | Frase de búsqueda por palabra clave. 1 hasta 2048 caracteres. |
max_results | entero | No | Número de resultados a devolver. 1–20. por defecto 10 |
location | cadena | No | Código de país ISO 3166-1 alfa-2, por ejemplo DE. por defecto null |
| Campo | Tipo | Descripción |
|---|---|---|
state | cadena | done. faulted en un 500 |
results[] | arreglo | Resultados orgánicos clasificados, los mejores primero. Vacío cuando no hubo coincidencias |
results[].title | cadena | Título de la página |
results[].outline | arreglo de cadenas | Fragmentos de contenido. Cada elemento está truncado |
results[].url | cadena | URL absoluta del resultado |
results[].metadata.position | entero | Rango, comenzando en 1 |
related_questions[] | arreglo | Entradas de "People also ask". Se omite cuando está vacío |
related_questions[].question | cadena | La pregunta. Siempre presente |
related_questions[].title | cadena | Título de la página de respuesta (Opcional) |
related_questions[].snippet | cadena | Extracto que responde la pregunta. Truncado (Opcional) |
related_searches[] | arreglo | Consultas relacionadas, cada una con un query. Se omite cuando está vacío |
params | objeto | Parámetros usados para la solicitud, con los valores predeterminados completados |
metadata.timestamp | entero | Marca temporal Unix en segundos |
metadata.request_id | cadena | Identificador de la solicitud |
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
url | cadena | sí | Absoluta http o https URL. Envíela sin cambios; las cadenas de consulta y los segmentos de ruta son significativos |
output | arreglo de cadenas | no | Formatos a devolver: ["html"] (predeterminado), ["markdown"], ["json"], ["screenshot"].json devuelve campos analizados (mediante analizadores dedicados o análisis con IA). screenshot requiere run_js: true |
json | objeto | no | Requerido cuando output incluye json (y no hay un analizador dedicado disponible): {"prompt": string} o {"schema": object}, nunca ambos |
json.prompt | cadena | no | Instrucciones de extracción en lenguaje natural para output: ["json"]. max_len: 8192, por defecto: null. No se puede usar con json.schema. |
json.schema | objeto | no | Objeto OpenAPI / JSON Schema que define la forma requerida de la salida JSON. 10 hasta 65535 caracteres, por defecto: null. No se puede usar con json.prompt |
location | cadena | no | Código de país de dos letras para obtener, por ejemplo DE |
device | cadena | no | escritorio (predeterminado) o móvil |
run_js | booleano | no | Ejecuta el JavaScript de la página antes de la captura. Más lento; use un tiempo de espera del cliente de 150 segundos o más |
callback_url | cadena | no | Solo asíncrono. URL de webhook para el trabajo finalizado. Las URL mal formadas se rechazan con 400 |
storage | objeto | no | Solo asíncrono. Entrega el resultado a un bucket en lugar de la respuesta: {"type": string, "url": string}. type es s3, s3_gzip, s3_compatible, gcs, o tos. url no se valida |
| Campo | Tipo | Descripción |
|---|---|---|
state | cadena | done, pendiente, o faulted |
estado | entero | Presente en respuestas de error. Código de estado HTTP |
results[] | arreglo | Una entrada para la URL solicitada. Presente cuando state es done |
results[].markdown | cadena | La página como Markdown. Presente cuando se solicita |
results[].html | cadena | El marcado sin procesar. Presente cuando se solicita |
results[].json | objeto | Campos analizados. Presente cuando se solicita |
results[].screenshot | cadena | La captura de pantalla. Presente cuando se solicita |
results[].metadata.url | cadena | La URL obtenida, después de las redirecciones |
results[].metadata.statuses | objeto | Estados etiquetados de procesamiento HTTP, análisis y otros |
params | objeto | Parámetros usados para la solicitud, con los valores predeterminados completados. Los valores nulos se conservan |
metadata.timestamp | entero | Marca temporal Unix en segundos |
metadata.request_id | cadena | Identificador de la solicitud |
metadata.statuses | objeto | Estados etiquetados a nivel de solicitud, como el estado de entrega de almacenamiento |