Bulk Seed Entities

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

bucket?string

Optional bucket public ID (bkt_...) to seed into. Omit to use the account+environment default bucket.

entities*array<>

The entities to seed. Must be non-empty.

onConflict?string

Conflict strategy for an entity that already exists. Only merge is supported and it is the default: synonyms are added additively, a longer description replaces the old one, and attributes are merged with new keys winning.

Value in"merge"

Response Body

`application/json`

curl -X POST "https://api.bem.ai/v3/entities/bulk" \  -H "Content-Type: application/json" \  -d '{    "entities": [      {        "canonical": "Acme Corporation",        "type": "organization",        "description": "Industrial conglomerate",        "synonyms": [          "ACME",          "Acme Corp"        ],        "attributes": {          "headquarters": "Springfield"        }      }    ],    "onConflict": "merge"  }'

{
  "results": [
    {
      "canonical": "string",
      "outcome": "created",
      "entityID": "string",
      "reason": "string"
    }
  ],
  "summary": {
    "created": 0,
    "merged": 0,
    "rejected": 0
  }
}

{
  "seedJobID": "string",
  "status": "string",
  "statusURL": "string"
}

Bulk Seed Entities

Authorization

Request Body

Response Body

200application/json

202application/json

`application/json`

`application/json`