Skip to main content
POST
/
entities
/
search
Search Entities
curl --request POST \
  --url https://api.hyperspell.com/entities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "type": "<string>",
  "limit": 20
}
'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "name": "<string>",
      "mention_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "similarity": 123,
      "description": "<string>",
      "attributes": {},
      "first_seen_resource_id": "<string>",
      "last_seen_resource_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Body

application/json
​
query
string
required
​
type
string | null
​
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Successful Response

​
items
EntityWithScoreResponse · object[]
required