Skip to main content
GET
Knowledge Domains: List Entities

Overview

Entities are extracted from your documents and stored per container. Access is restricted to the container owner derived from your BBOT-API-Key.

Authentication

Send your API key:
BBOT-API-Key
string
Your BBOT API key

Path Parameters

container_id
string
required
Knowledge container id (example: userId_expertId_knowledge_name)

Query Parameters

type
string
Optional entity type filter (for example: PERSON, ORGANIZATION)
limit
integer
default:"200"
Max items to return (1-1000)
offset
integer
default:"0"
Pagination offset

Response

items
array
Entity entries with name, type, description, aliases, confidence, attributes_json, document_count, documents
total
integer
Total matching entities
limit
integer
Applied limit
offset
integer
Applied offset

Example Request

cURL