Zum Hauptinhalt springen
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
  }
}

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Body

application/json
​
query
string
erforderlich

Die Suchanfrage in natürlicher Sprache.

Beispiel:

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

​
limit
integer
Standard:12

Maximale Anzahl von Links, die nach der Duplikatsentfernung zurückgegeben werden.

Erforderlicher Bereich: 1 <= x <= 25
Beispiel:

10

​
include_domains
string[]

Ergebnisse auf diese Domains beschränken. Nur nackte Hosts — führendes http(s):// und abschließende Schrägstriche werden automatisch entfernt.

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

Ergebnisse von diesen Domains ausschließen. Nur nackte Hosts — führendes http(s):// und abschließende Schrägstriche werden automatisch entfernt.

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

Optional. Wenn angegeben, wird jeder zurückgegebene Link auch gescraped und sein Inhalt in die Antwort eingebettet. Pro-Seite-Scrape-Credits werden automatisch über den zugrunde liegenden /v1/scrapes-Endpunkt abgerechnet.

Antwort

Erfolgreiche Antwort mit Suchergebnissen.

​
id
string
Beispiel:

"search_9bi0sbj9xa"

​
object
string
Beispiel:

"search"

​
created
integer
Beispiel:

1760327323

​
metadata
object
​
query
string
Beispiel:

"Best Answer Engine Optimization startups"

​
credits_consumed
integer

Gesamte Credits, die durch diese Anfrage verbraucht wurden: 5 Basis-Such-Credits + Summe der pro Seite verbrauchten Scrape-Credits, wenn scrape_options verwendet wurde.

Beispiel:

10

​
result
object