Skip to main content
POST
/
catchAll
/
entities
Create entity
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/entities \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "NewsCatcher",
  "entity_type": "company",
  "description": "AI-powered news data provider",
  "additional_attributes": {
    "company_attributes": {
      "domain": "newscatcherapi.com",
      "alternative_names": [
        "NC",
        "NewsCatcher API"
      ],
      "key_persons": [
        "Artem Bugara",
        "Maksym Sugonyaka"
      ]
    }
  }
}
'
{
  "id": "854198fa-f702-49db-a381-0427fa87f173",
  "status": "pending"
}

Authorizations

x-api-key
string
header
required

API key for authentication.

Body

application/json

Request body for creating a single entity. Only name is required. The more fields you provide, the better the matching quality.

name
string
required

The company or person name. Required and must be non-empty.

Minimum string length: 1
Example:

"NewsCatcher"

entity_type
enum<string>
default:company

The type of entity.

  • company: A company or organization (default).
  • person: An individual person.
Available options:
company,
person
description
string

Free-text description of the entity used for disambiguation when similar names exist.

Example:

"AI-powered news data provider"

additional_attributes
object

Additional attributes for the entity, keyed by entity type.

Response

Entity created successfully.

id
string<uuid>
required

Unique identifier of the created entity.

Example:

"854198fa-f702-49db-a381-0427fa87f173"

status
string
required

Initial status of the entity. Always pending immediately after creation — enrichment happens asynchronously.

Example:

"pending"