Skip to main content
GET
/
v1
/
knowledge
/
entities
Search Entities
curl --request GET \
  --url https://api.cala.ai/v1/knowledge/entities \
  --header 'X-API-KEY: <api-key>'
{
  "entities": [
    {
      "entity_type": "ORG",
      "id": 1160,
      "name": "OpenAI"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

name
string
required

Entity name to search for

Minimum string length: 1
entity_types
enum<string>[]

Filter by entity types

Available options:
PERSON,
FAC,
ORG,
GPE,
LOC,
PRODUCT,
WORK_OF_ART,
LAW,
LANGUAGE
limit
integer
default:20

Maximum number of results

Required range: 1 <= x <= 100

Response

Successful Response

Response containing a list of entities matching the search query.

entities
Entity · object[]
required

List of entities matching the search query, ordered by relevance (most relevant first).