Hosted platformREST API reference

Conversations

What the routed chat remembers for the caller: conversations the platform keeps for `/v1/chat/completions` (`osr.conversation_id` continues one across desktop, browser and playground; the platform prepends the history and a rolling summary) and the long-term memory - facts the person stated about themselves, listed, edited, disabled or deleted here; `PUT /memory/settings` turns it off.

Hosted platformAPI version 1.7.0

get	/api/v1/conversations	List Conversations
delete	/api/v1/conversations	Delete Conversations
get	/api/v1/conversations/{conversation_id}	Get Conversation
patch	/api/v1/conversations/{conversation_id}	Rename Conversation
delete	/api/v1/conversations/{conversation_id}	Delete Conversation
post	/api/v1/conversations/{conversation_id}/split	Split Conversation
get	/api/v1/memory	Get Memory
post	/api/v1/memory	Add Memory
delete	/api/v1/memory	Delete Memories
put	/api/v1/memory/settings	Put Memory Settings
patch	/api/v1/memory/{memory_id}	Patch Memory
delete	/api/v1/memory/{memory_id}	Delete Memory

get/api/v1/conversations

List Conversations

Requires an API key

Parameters

Name	In	Type	Default
client	query	string \| null
q	query	string	""
limit	query	integer	50

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/conversations?q=&limit=50" \
  -H "Authorization: Bearer $OSR_API_KEY"

delete/api/v1/conversations

Delete Conversations

Requires an API key

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/conversations" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/conversations/{conversation_id}

Get Conversation

Requires an API key

Parameters

Name	In	Type	Default	Description
conversation_id(required)	path	string

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/conversations/<conversation_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

patch/api/v1/conversations/{conversation_id}

Rename Conversation

Requires an API key

Parameters

Name	In	Type	Default	Description
conversation_id(required)	path	string

Request bodyConversationPatch

Field	Type	Default	Description
title(required)	string

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PATCH "$OSR_URL/api/v1/conversations/<conversation_id>" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "string" }'

Bodyjson

{
  "title": "string"
}

delete/api/v1/conversations/{conversation_id}

Delete Conversation

Requires an API key

Parameters

Name	In	Type	Default	Description
conversation_id(required)	path	string

Responses

204	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/conversations/<conversation_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/conversations/{conversation_id}/split

Split Conversation

A topic change the person confirmed: the turns from from_seq on become their own conversation.

Requires an API key

Parameters

Name	In	Type	Default	Description
conversation_id(required)	path	string

Request bodyConversationSplitIn

Field	Type	Default	Description
from_seq(required)	integer

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/conversations/<conversation_id>/split" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "from_seq": 1 }'

Bodyjson

{
  "from_seq": 1
}

get/api/v1/memory

Get Memory

Requires an API key

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/memory" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/memory

Add Memory

Requires an API key

Request bodyMemoryIn

Field	Type	Default	Description
content(required)	string
kind	string	"note"

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/memory" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "content": "Prove that sqrt(2) is irrational." }'

Bodyjson

{
  "content": "Prove that sqrt(2) is irrational."
}

delete/api/v1/memory

Delete Memories

Requires an API key

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/memory" \
  -H "Authorization: Bearer $OSR_API_KEY"

put/api/v1/memory/settings

Put Memory Settings

Requires an API key

Request bodyMemorySettingsIn

Field	Type	Default	Description
enabled(required)	boolean

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PUT "$OSR_URL/api/v1/memory/settings" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false }'

Bodyjson

{
  "enabled": false
}

patch/api/v1/memory/{memory_id}

Patch Memory

Requires an API key

Parameters

Name	In	Type	Default	Description
memory_id(required)	path	string

Request bodyMemoryPatch

Field	Type	Default	Description
content	string \| null
disabled	boolean \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X PATCH "$OSR_URL/api/v1/memory/<memory_id>" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "content": "Prove that sqrt(2) is irrational.", "disabled": false }'

Bodyjson

{
  "content": "Prove that sqrt(2) is irrational.",
  "disabled": false
}

delete/api/v1/memory/{memory_id}

Delete Memory

Requires an API key

Parameters

Name	In	Type	Default	Description
memory_id(required)	path	string

Responses

204	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X DELETE "$OSR_URL/api/v1/memory/<memory_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

Account, keys and tenants

The calling workspace: profile, usage, savings, activity log, API keys and tenants.

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.

Conversations

get/api/v1/conversations

Parameters

Responses

delete/api/v1/conversations

Responses

get/api/v1/conversations/{conversation_id}

Parameters

Responses

patch/api/v1/conversations/{conversation_id}

Parameters

Request bodyConversationPatch

Responses

delete/api/v1/conversations/{conversation_id}

Parameters

Responses

post/api/v1/conversations/{conversation_id}/split

Parameters

Request bodyConversationSplitIn

Responses

get/api/v1/memory

Responses

post/api/v1/memory

Request bodyMemoryIn

Responses

delete/api/v1/memory

Responses

put/api/v1/memory/settings

Request bodyMemorySettingsIn

Responses

patch/api/v1/memory/{memory_id}

Parameters

Request bodyMemoryPatch

Responses

delete/api/v1/memory/{memory_id}

Parameters

Responses

On this page