Passer au contenu principal
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>"
      }
    ]
  }
}

​
Introduction

Cette API vous permet de créer une nouvelle recherche dans le système Olostep. Vous pouvez spécifier divers paramètres pour affiner votre recherche et obtenir des résultats précis.

​
Paramètres de la Requête

  • query (string, requis) : La chaîne de recherche que vous souhaitez utiliser.
  • filters (objet, optionnel) : Un ensemble de filtres pour restreindre les résultats.
  • sort (string, optionnel) : Le critère de tri pour les résultats.

​
Exemple de Requête

POST /v1/searches
Content-Type: application/json

{
  "query": "exemple de recherche",
  "filters": {
    "date": "2023-10-01"
  },
  "sort": "pertinence"
}

​
Réponse

Une réponse réussie retournera un objet JSON contenant les détails de la recherche créée.

​
Exemple de Réponse

{
  "id": "12345",
  "status": "en cours",
  "result_count": 100
}

​
Erreurs

  • 400 Bad Request : Paramètres de requête invalides.
  • 401 Unauthorized : Authentification requise.
  • 500 Internal Server Error : Erreur serveur inattendue.

​
Notes

Assurez-vous que votre requête est correctement formatée et que tous les paramètres requis sont inclus. Pour plus d’informations, consultez la documentation complète de l’API.

Autorisations

​
Authorization
string
header
requis

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

Corps

application/json
​
query
string
requis

Die Suchabfrage in natürlicher Sprache.

Réponse

Erfolgreiche Antwort mit Suchergebnissen.

​
id
string
Exemple:

"search_9bi0sbj9xa"

​
object
string
Exemple:

"search"

​
created
integer
Exemple:

1760327323

​
metadata
object
​
query
string
Exemple:

"Best Answer Engine Optimization startups"

​
result
object