Vai al contenuto principale
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
  }
}

Autorizzazioni

Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer del tipo Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
query
string
obbligatorio

La query di ricerca in linguaggio naturale.

Esempio:

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

limit
integer
predefinito:12

Numero massimo di link da restituire dopo la deduplicazione.

Intervallo richiesto: 1 <= x <= 25
Esempio:

10

include_domains
string[]

Restringi i risultati a questi domini. Solo host nudi — http(s):// iniziali e slash finali vengono rimossi automaticamente.

Esempio:
["nytimes.com", "wsj.com"]
exclude_domains
string[]

Escludi i risultati da questi domini. Solo host nudi — http(s):// iniziali e slash finali vengono rimossi automaticamente.

Esempio:
["reddit.com"]
scrape_options
object

Facoltativo. Quando fornito, ogni link restituito viene anche analizzato e il suo contenuto viene incorporato nella risposta. I crediti per ogni pagina analizzata vengono addebitati automaticamente dall'endpoint sottostante /v1/scrapes.

Risposta

Risposta riuscita con risultati di ricerca.

id
string
Esempio:

"search_9bi0sbj9xa"

object
string
Esempio:

"search"

created
integer
Esempio:

1760327323

metadata
object
query
string
Esempio:

"Best Answer Engine Optimization startups"

credits_consumed
integer

Crediti totali consumati da questa richiesta: 5 crediti base di ricerca + somma dei crediti per pagina quando sono state usate scrape_options.

Esempio:

10

result
object