Skip to main content
GET
/
v1
/
entities
Search Entities
curl --request GET \
  --url https://api.cala.ai/v1/entities \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.cala.ai/v1/entities"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.cala.ai/v1/entities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "entities": [
    {
      "description": "An American multinational technology company.",
      "entity_type": "Company",
      "id": "e5bb591a-d308-4aa5-9672-96046d366cde",
      "name": "OpenAI"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"error": "rate_limit_exceeded",
"message": "Rate limit exceeded. Too many requests."
}

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:
Entity,
Animal,
Award,
Organization,
Company,
EducationalInstitution,
IntergovernmentalOrganization,
Person,
Event,
GPE,
Country,
CountrySubdivision,
DependentTerritory,
Municipality,
Continent,
Currency,
Industry,
FinancialMetric,
Group,
CorporateEvent,
PrivateCompanyFundingRound,
Facility,
Location,
Organism,
Plant,
Product,
Sanction,
WorkOfArt,
Law,
Language,
Exchange,
Future,
Commodity,
PositioningMetric,
MacroIndicatorPublication,
MacroIndicator,
ForeignExchangeRate,
CountryRegion
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).