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

Autorisations

Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Corps

application/json
query
string
requis

La requête de recherche en langage naturel.

Exemple:

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

limit
integer
défaut:12

Nombre maximum de liens à retourner après déduplication.

Plage requise: 1 <= x <= 25
Exemple:

10

include_domains
string[]

Restreindre les résultats à ces domaines. Hôtes nus uniquement — les http(s):// initiaux et les barres obliques finales sont automatiquement supprimés.

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

Exclure les résultats de ces domaines. Hôtes nus uniquement — les http(s):// initiaux et les barres obliques finales sont automatiquement supprimés.

Exemple:
["reddit.com"]
scrape_options
object

Optionnel. Lorsqu'il est fourni, chaque lien retourné est également exploré et son contenu est intégré dans la réponse. Les crédits d'exploration par page sont facturés automatiquement par le point de terminaison sous-jacent /v1/scrapes.

Réponse

Réponse réussie avec les résultats de recherche.

id
string
Exemple:

"search_9bi0sbj9xa"

object
string
Exemple:

"search"

created
integer
Exemple:

1760327323

metadata
object
query
string
Exemple:

"Best Answer Engine Optimization startups"

credits_consumed
integer

Total des crédits consommés par cette requête : 5 crédits de recherche de base + somme des crédits par page de scraping lorsque scrape_options a été utilisé.

Exemple:

10

result
object