Skip to content
Documentation
Hosted platformREST API reference

Knowledge

The workspace's knowledge graph: typed, sourced facts about the people who ask, the targets, the topics and the sources, learned from the routed chat and added by hand; the engineered context placed before every chat (preview it with `POST /knowledge/context`), suggestions from the workspace's trained link predictor, and exports to JSON-LD, N-Triples, GraphML and Cypher.

Hosted platformAPI version 1.7.0

`PUT /knowledge/settings` turns it off or changes the token budget.

get/api/v1/knowledge

Overview

Requires an API key

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/knowledge" \
  -H "Authorization: Bearer $OSR_API_KEY"

delete/api/v1/knowledge

Delete Personal

Requires an API key

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X DELETE "$OSR_URL/api/v1/knowledge" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/knowledge/context

Preview Context

Requires an API key

Request bodyContextIn

FieldTypeDefaultDescription
budget_tokensinteger | null
text(required)string

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X POST "$OSR_URL/api/v1/knowledge/context" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Prove that sqrt(2) is irrational." }'
Bodyjson
{
  "text": "Prove that sqrt(2) is irrational."
}

get/api/v1/knowledge/export

Export

Requires an API key

Parameters

NameInTypeDefaultDescription
formatquerystring"jsonld"
personalquerybooleantrue

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/knowledge/export?format=jsonld&personal=true" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/knowledge/facts

List Facts

Requires an API key

Parameters

NameInTypeDefaultDescription
qquerystring""
predicatequerystring | null
personalqueryboolean | null
limitqueryinteger100

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/knowledge/facts?q=&limit=100" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/knowledge/facts

Add Fact

Requires an API key

Request bodyFactIn

FieldTypeDefaultDescription
confidencenumber1
object(required)string
predicate(required)string
subjectstring | null

Responses

201Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X POST "$OSR_URL/api/v1/knowledge/facts" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "object": "string", "predicate": "string" }'
Bodyjson
{
  "object": "string",
  "predicate": "string"
}

delete/api/v1/knowledge/facts

Delete Facts

Requires an API key

Parameters

NameInTypeDefaultDescription
subjectquerystring | null
predicatequerystring | null
objectquerystring | null

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X DELETE "$OSR_URL/api/v1/knowledge/facts" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/knowledge/forget

Forget

Requires an API key

Request bodyForgetIn

FieldTypeDefaultDescription
phrase(required)string

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X POST "$OSR_URL/api/v1/knowledge/forget" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phrase": "string" }'
Bodyjson
{
  "phrase": "string"
}

put/api/v1/knowledge/settings

Put Settings

Requires an API key

Request bodyKnowledgeSettingsIn

FieldTypeDefaultDescription
budget_tokensinteger | null
enabledboolean | null

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X PUT "$OSR_URL/api/v1/knowledge/settings" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "budget_tokens": 1, "enabled": false }'
Bodyjson
{
  "budget_tokens": 1,
  "enabled": false
}

get/api/v1/knowledge/suggest

Suggest

Requires an API key

Parameters

NameInTypeDefaultDescription
subject(required)querystring
predicate(required)querystring
kqueryinteger5

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/knowledge/suggest?k=5" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/knowledge/train

Train

Requires an API key

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s -X POST "$OSR_URL/api/v1/knowledge/train" \
  -H "Authorization: Bearer $OSR_API_KEY"