Saltar al contenido principal
POST
/
v1
/
searches
curl --request POST \
  --url https://api.olostep.com/v1/searches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Best Answer Engine Optimization startups"
}
'
{
  "id": "search_9bi0sbj9xa",
  "object": "search",
  "created": 1760327323,
  "metadata": {},
  "query": "Best Answer Engine Optimization startups",
  "credits_consumed": 10,
  "result": {
    "json_content": "<string>",
    "json_hosted_url": "<string>",
    "links": [
      {
        "url": "<string>",
        "title": "<string>",
        "description": "<string>",
        "markdown_content": "<string>",
        "html_content": "<string>"
      }
    ],
    "size_exceeded": true,
    "credits_consumed": 123
  }
}

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Cuerpo

application/json
​
query
string
requerido

La consulta de búsqueda en lenguaje natural.

Ejemplo:

"What's going on with OpenAI's Sora shutting down?"

​
limit
integer
predeterminado:12

Número máximo de enlaces a devolver después de la deduplicación.

Rango requerido: 1 <= x <= 25
Ejemplo:

10

​
include_domains
string[]

Restringe los resultados a estos dominios. Solo hosts básicos — los http(s):// iniciales y las barras finales se eliminan automáticamente.

Ejemplo:
["nytimes.com", "wsj.com"]
​
exclude_domains
string[]

Excluye resultados de estos dominios. Solo hosts básicos — los http(s):// iniciales y las barras finales se eliminan automáticamente.

Ejemplo:
["reddit.com"]
​
scrape_options
object

Opcional. Cuando se proporciona, cada enlace devuelto también se raspa y su contenido se incrusta en la respuesta. Los créditos de raspado por página se facturan automáticamente por el endpoint subyacente /v1/scrapes.

Respuesta

Respuesta exitosa con resultados de búsqueda.

​
id
string
Ejemplo:

"search_9bi0sbj9xa"

​
object
string
Ejemplo:

"search"

​
created
integer
Ejemplo:

1760327323

​
metadata
object
​
query
string
Ejemplo:

"Best Answer Engine Optimization startups"

​
credits_consumed
integer

Créditos totales consumidos por esta solicitud: 5 créditos base de búsqueda + suma de créditos por página cuando se usó scrape_options.

Ejemplo:

10

​
result
object