For the complete documentation index, see llms.txt. This page is also available as Markdown.

Context Graphs

List context graphs

get

List context graphs in a workspace with pagination. Requires ContextGraph.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
searchstring · min: 1 · max: 200 · nullableOptional
sort_bystring · nullableOptional
limitinteger · max: 100OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokeninteger · nullableOptional
totalinteger · nullableOptional
get/v1/{workspace_id}/context-graphs

Create a context graph

post

Create a new context graph in a workspace. Requires ContextGraph.create permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
namestring · min: 1 · max: 256Required
descriptionstring · max: 2000OptionalDefault: ""
Responses
201

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
latest_versionintegerOptionalDefault: 0
state_countintegerOptionalDefault: 0
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/v1/{workspace_id}/context-graphs

Get a context graph

get

Retrieve a context graph by ID. Requires ContextGraph.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
latest_versionintegerOptionalDefault: 0
state_countintegerOptionalDefault: 0
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/v1/{workspace_id}/context-graphs/{context_graph_id}

Update a context graph

put

Update a context graph's name or description. Requires ContextGraph.update permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
Body
namestring · min: 1 · max: 256 · nullableOptional
descriptionstring · max: 2000 · nullableOptional
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
descriptionstringRequired
latest_versionintegerOptionalDefault: 0
state_countintegerOptionalDefault: 0
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
put/v1/{workspace_id}/context-graphs/{context_graph_id}

Delete a context graph

delete

Delete a context graph. context graph versions are retained. Requires ContextGraph.delete permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/v1/{workspace_id}/context-graphs/{context_graph_id}

No content

List context graph versions

get

List versions of a context graph with pagination. Requires ContextGraph.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
Query parameters
sort_bystring · nullableOptional
limitinteger · max: 100OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokeninteger · nullableOptional
totalinteger · nullableOptional
get/v1/{workspace_id}/context-graphs/{context_graph_id}/versions

Create a context graph version

post

Create a new version of a context graph. Version number is auto-incremented. Requires ContextGraph.create permission for the first version and ContextGraph.update permission afterward.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
Body
descriptionstring · max: 2000OptionalDefault: ""
new_user_initial_statestringRequired
returning_user_initial_statestringRequired
terminal_statestringRequired
global_intra_state_navigation_guidelinesstring[]OptionalDefault: []
global_action_guidelinesstring[]OptionalDefault: []
global_boundary_constraintsstring[]OptionalDefault: []
topology_descriptionstring · nullableOptional
Responses
201

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
versionintegerRequired
descriptionstringRequired
new_user_initial_statestringRequired
returning_user_initial_statestringRequired
terminal_statestringRequired
global_intra_state_navigation_guidelinesstring[]Required
global_action_guidelinesstring[]Required
global_boundary_constraintsstring[]Required
topology_descriptionstring · nullableRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/v1/{workspace_id}/context-graphs/{context_graph_id}/versions

Get a context graph version

get

Retrieve a specific context graph version by number, or 'latest'. Requires ContextGraph.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
versionany ofRequired
integerOptional
or
stringOptional
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
context_graph_idstring · uuidRequired
versionintegerRequired
descriptionstringRequired
new_user_initial_statestringRequired
returning_user_initial_statestringRequired
terminal_statestringRequired
global_intra_state_navigation_guidelinesstring[]Required
global_action_guidelinesstring[]Required
global_boundary_constraintsstring[]Required
topology_descriptionstring · nullableRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/v1/{workspace_id}/context-graphs/{context_graph_id}/versions/{version}

Last updated

Was this helpful?