POST
/
v1
/
links
Analyze links
curl --request POST \
  --url https://searchlysis.com/api/v1/links \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "metadata": {},
  "link": [
    "<string>"
  ],
  "prompt": "<string>",
  "temperature": 0.8,
  "responseFormat": {}
}'
{
  "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>",
        "extras": {
          "imageLinks": [
            "<string>"
          ]
        },
        "text": "<string>"
      },
      "textContent": "<string>",
      "jsonContent": {}
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json

Array of links(URLs that start with https) to analyze

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

temperature
number

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

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

0.8

responseFormat
object

To use structured outputs, include a response_format parameter in your request, with type set to json_schema and the json_schema object containing your schema

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