ARarbicity
workspace

Create Protected Workspace

Changed on

Create a new workspace with encryption and access controls. Sets up vector storage and associates the creator as the initial workspace user.

Server generates the workspace symmetric key and wraps it with the user's public key. The wrapped key is returned in the response for client-side storage.

Public workspaces are visible to all users and grant non-members limited access:

  • Non-members can view shared documents and tags
  • Non-members can create conversations and send messages
  • Only members can upload documents
  • Only members can see the member list

Only users with developer flag can create public workspaces.

post/api/workspace/create_protected

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring nullable
is_publicboolean

Response

Successful Response

external_idstring required
namestring required
descriptionstring nullable required
is_publicboolean required
created_by_ext_idstring required
updated_by_ext_idstring nullable
created_atstring date-time required
updated_atstring date-time required
wrapped_keystring nullable
shared_conversation_countinteger
private_conversation_countinteger
shared_document_countinteger
private_document_countinteger
user_files_mbnumber

Changes

  • b91e4b449d56Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • aa4b06f8dedeRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status