跳转到主要内容
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>"
      }
    ]
  }
}
创建一个新的搜索请求以获取特定数据。

​
请求

要创建搜索，请向 /v1/searches 端点发送 POST 请求。请求体应该包含以下字段：
  • query (字符串): 要搜索的查询字符串。
  • filters (对象): 可选的过滤器对象，用于限制搜索结果。
  • sort (字符串): 可选的排序顺序，例如 asc 或 desc。

​
示例请求

{
  "query": "example search",
  "filters": {
    "category": "books"
  },
  "sort": "asc"
}

​
响应

成功的响应将返回一个包含搜索结果的对象。

​
示例响应

{
  "results": [
    {
      "id": "1",
      "title": "Example Book",
      "author": "John Doe"
    }
  ],
  "total": 1
}

​
错误

如果请求无效，API 将返回一个错误响应。

​
示例错误响应

{
  "error": "Invalid query parameter"
}
确保请求体格式正确，并包含所有必需字段。

授权

​
Authorization
string
header
必填

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

请求体

application/json
​
query
string
必填

Die Suchabfrage in natürlicher Sprache.

响应

Erfolgreiche Antwort mit Suchergebnissen.

​
id
string
示例:

"search_9bi0sbj9xa"

​
object
string
示例:

"search"

​
created
integer
示例:

1760327323

​
metadata
object
​
query
string
示例:

"Best Answer Engine Optimization startups"

​
result
object