Get (or generate) an AI summary for a search

GET

https://api.sherlockeye.io/v1/searches/{searchId}/summary

Summary

Last modified:2026-01-28 20:51:30

Returns a natural‑language summary of the search results. If no summary
exists yet for the given searchId, the server will generate one using
the current data, persist it, and then return it.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.sherlockeye.io/v1/searches//summary?language' \
--header 'Authorization: Bearer <token>'

Responses

🟢200

application/json

Summary successfully returned.

Body

Example

{
    "success": true,
    "data": {
        "searchId": "string",
        "query": "string",
        "summary": "string",
        "status": "processing",
        "timestamp": "2019-08-24T14:15:22.123Z"
    }
}

🟠400

🟠401

🟠404

🔴500

Modified at 2026-01-28 20:51:30

ErrorResponse