POST
/
v1
/
search
curl --request POST \
  --url https://searchlysis.com/api/v1/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "metadata": {},
  "query": "searchlysis",
  "num": 10,
  "startPublishedDate": "<string>",
  "endPublishedDate": "<string>",
  "prompt": "<string>",
  "temperature": 0.8
}'
{
  "usageId": "<string>",
  "metadata": {},
  "costCredits": 123,
  "results": [
    {
      "analysisId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "analysis": {
        "title": "<string>",
        "url": "<string>",
        "publishedDate": "<string>",
        "author": "<string>",
        "score": 123,
        "id": "<string>",
        "image": "<string>",
        "favicon": "<string>",
        "text": "<string>",
        "content": "<string>"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
query
string
required

The query string for the search.

Example:

"searchlysis"

​
prompt
string
required
​
metadata
object

User defined key-value pair where the key is a string, and the value can be a string, number, boolean, or null

​
num
integer
default:10

Number of results to return (up to thousands of results available for custom plans)

Required range: 1 <= x <= 100
Example:

10

​
startPublishedDate
string

Start date for published date filter (2023-01-01T00:00:00.000Z)

​
endPublishedDate
string

End date for published date filter (2023-12-31T00:00:00.000Z)

​
temperature
number

Sampling temperature (range: [0, 2]).

Required range: 0 <= x <= 2
Example:

0.8

Response

200 - application/json
Successful operation
​
usageId
string
required
​
costCredits
integer
required

Total credits cost for your request

​
results
object[]
required
​
metadata
object

User defined key-value pair where the key is a string, and the value can be a string, number, boolean, or null