Skip to main content
GET
/
v0
/
containers
/
{container_id}
/
relationships
Knowledge Domains: List Relationships
curl --request GET \
  --url https://api.example.com/v0/containers/{container_id}/relationships
{
  "items": [
    {}
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Overview

Relationships are inferred 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 relationship type filter (for example: RELATED_TO)
limit
integer
default:"200"
Max items to return (1-1000)
offset
integer
default:"0"
Pagination offset

Response

items
array
Relationship entries with source, relationship, and target
total
integer
Total matching relationships
limit
integer
Applied limit
offset
integer
Applied offset

Example Request

cURL
curl --location 'https://api.b-bot.space/api/v0/containers/<container_id>/relationships?limit=5' \
  --header 'BBOT-API-Key: <your-bbot-api-key>'