Spaces
Shared homes for conversations, with their own membership.
List spaces
Spaces nest. Pass space_parent with a space id for that space's children, or the literal root for the top level.
query Parameters
cursor^[A-Za-z0-9_-]+$full_text_searchlimitoffsetsort^-?[a-z0-9_]+$space_activespace_idspace_namespace_parentHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List spaces › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a space
Creates a space. Spaces can nest, and a thread lives in at most one of them.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a space › Request Body
space_namespace_descriptionspace_iconspace_colorspace_parentspace_default_agentspace_system_promptspace_metadataspace_aclCreate a space › Responses
Created
space_idspace_activespace_createdspace_updatedspace_created_byspace_namespace_descriptionspace_iconspace_colorspace_parentspace_default_agentspace_system_promptspace_knowledgespace_metadatathread_countchild_countGet a space
Returns the space with its membership and where it sits in the tree.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a space › Responses
Success
space_idspace_activespace_createdspace_updatedspace_created_byspace_namespace_descriptionspace_iconspace_colorspace_parentspace_default_agentspace_system_promptspace_knowledgespace_metadatathread_countchild_countDelete a space
Deletes the space itself. Threads inside it are not deleted — they revert to being personal threads belonging to whoever started them.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a space › Responses
Success. No content.
Update a space
Applies the space_-prefixed fields present in the body. Only an owner may change who has access or move the space.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a space › Request Body optional
space_namespace_descriptionspace_iconspace_colorspace_parentspace_default_agentspace_system_promptspace_metadataspace_aclspace_activeUpdate a space › Responses
Success
space_idspace_activespace_createdspace_updatedspace_created_byspace_namespace_descriptionspace_iconspace_colorspace_parentspace_default_agentspace_system_promptspace_knowledgespace_metadatathread_countchild_countList members
Each member with the operations they hold on the space.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List members › Responses
Success
Add or update a member
One call for both: the member's entry is written to whatever role says, whether or not they were already a member. Only a space owner may call it.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Add or update a member › Request Body
usr_idroleAdd or update a member › Responses
Success
Remove a member
Removes one member. Threads they started stay in the space.
path Parameters
iduser_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Remove a member › Responses
Success. No content.
Add a thread
Two permissions meet here, and both are required: write access to the space, and either ownership of the thread or write access to it. A private thread becomes visible to the space when it moves in; a thread already shared more widely keeps its sharing.
path Parameters
idthread_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Add a thread › Responses
Success
Remove a thread
Takes the thread out of the space without deleting it — it goes back to being the author's own.
path Parameters
idthread_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Remove a thread › Responses
Success. No content.