メインコンテンツへスキップ
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
  }
}

承認

​
Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

ボディ

application/json
​
query
string
必須

自然言語での検索クエリ。

例:

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

​
limit
integer
デフォルト:12

重複排除後に返すリンクの最大数。

必須範囲: 1 <= x <= 25
例:

10

​
include_domains
string[]

結果をこれらのドメインに制限。ホスト名のみ — 先頭の http(s):// と末尾のスラッシュは自動的に削除される。

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

これらのドメインからの結果を除外。ホスト名のみ — 先頭の http(s):// と末尾のスラッシュは自動的に削除される。

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

任意。指定された場合、返された各リンクもスクレイピングされ、その内容がレスポンスに埋め込まれます。ページごとのスクレイピングクレジットは、基盤となる/v1/scrapesエンドポイントによって自動的に請求されます。

レスポンス

検索結果を含む成功したレスポンス。

​
id
string
例:

"search_9bi0sbj9xa"

​
object
string
例:

"search"

​
created
integer
例:

1760327323

​
metadata
object
​
query
string
例:

"Best Answer Engine Optimization startups"

​
credits_consumed
integer

このリクエストで消費された合計クレジット: 5 基本検索クレジット + scrape_options が使用された場合のページごとのスクレイプクレジットの合計。

例:

10

​
result
object