Naar hoofdinhoud gaan
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
  }
}

Autorisaties

​
Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waar jouw auth token is.

Body

application/json
​
query
string
vereist

De zoekopdracht in natuurlijke taal.

Voorbeeld:

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

​
limit
integer
standaard:12

Maximum aantal links om terug te geven na deduplicatie.

Vereist bereik: 1 <= x <= 25
Voorbeeld:

10

​
include_domains
string[]

Beperk resultaten tot deze domeinen. Alleen kale hosts — vooraanstaande http(s):// en afsluitende schuine strepen worden automatisch verwijderd.

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

Sluit resultaten uit van deze domeinen. Alleen kale hosts — vooraanstaande http(s):// en afsluitende schuine strepen worden automatisch verwijderd.

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

Optioneel. Wanneer opgegeven, wordt elke geretourneerde link ook gescraped en de inhoud ervan in de respons ingebed. Scrape-credits per pagina worden automatisch gefactureerd door het onderliggende /v1/scrapes endpoint.

Respons

Succesvolle reactie met zoekresultaten.

​
id
string
Voorbeeld:

"search_9bi0sbj9xa"

​
object
string
Voorbeeld:

"search"

​
created
integer
Voorbeeld:

1760327323

​
metadata
object
​
query
string
Voorbeeld:

"Best Answer Engine Optimization startups"

​
credits_consumed
integer

Totale credits verbruikt door deze aanvraag: 5 basis zoekcredits + som van per-pagina scrape credits wanneer scrape_options werd gebruikt.

Voorbeeld:

10

​
result
object