Vai al contenuto principale
POST
/
v1
/
searches
Suche erstellen
curl --request POST \
  --url https://api.olostep.com/v1/searches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>"
}
'
{
  "id": "search_9bi0sbj9xa",
  "object": "search",
  "created": 1760327323,
  "metadata": {},
  "query": "Best Answer Engine Optimization startups",
  "result": {
    "json_content": "<string>",
    "json_hosted_url": "<string>",
    "links": [
      {
        "url": "<string>",
        "title": "<string>",
        "description": "<string>"
      }
    ]
  }
}

​
Introduzione

Questa API consente di creare una nuova ricerca nel sistema. Utilizza il metodo HTTP POST per inviare i dati della ricerca al server.

​
Esempio di Richiesta

Ecco un esempio di come inviare una richiesta per creare una ricerca: 
POST /v1/searches HTTP/1.1
Host: api.olostep.com
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "query": "esempio di ricerca",
  "filters": {
    "category": "tecnologia"
  }
}

​
Parametri

  • query: (stringa) La stringa di ricerca che si desidera utilizzare.
  • filters: (oggetto) Un oggetto che contiene i filtri da applicare alla ricerca.

​
Risposta

Se la richiesta ha esito positivo, il server restituirà una risposta con un codice di stato HTTP 201 e il corpo della risposta con i dettagli della ricerca creata. 
{
  "id": "12345",
  "query": "esempio di ricerca",
  "filters": {
    "category": "tecnologia"
  },
  "status": "creato"
}

​
Errori

In caso di errore, il server restituirà un codice di stato HTTP 4xx o 5xx con un messaggio di errore descrittivo.

​
Esempio di Risposta di Errore

{
  "error": "Parametro mancante: query"
}
Assicurati di fornire tutti i parametri richiesti per evitare errori.

Autorizzazioni

​
Authorization
string
header
obbligatorio

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
​
query
string
obbligatorio

Die Suchabfrage in natürlicher Sprache.

Risposta

Erfolgreiche Antwort mit Suchergebnissen.

​
id
string
Esempio:

"search_9bi0sbj9xa"

​
object
string
Esempio:

"search"

​
created
integer
Esempio:

1760327323

​
metadata
object
​
query
string
Esempio:

"Best Answer Engine Optimization startups"

​
result
object