Skip to content
Workshape Catalyst Operator Docs

Collaboration Workspaces

List the workspaces the caller belongs to

Section titled “List the workspaces the caller belongs to”

GET /api/v1/workspaces

Operation
workspaces.list
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Create a Shared Workspace

Section titled “Create a Shared Workspace”

POST /api/v1/workspaces

Operation
workspaces.create
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Request body

application/json: CreateCollaborationWorkspaceRequest

Answers

  • 200 The result

    application/json: CollaborationWorkspaceWithRole

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the Shared Workspaces a member can find

Section titled “List the Shared Workspaces a member can find”

GET /api/v1/workspaces/directory

Operation
workspaces.directory.list
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Create the caller’s personal workspace if missing

Section titled “Create the caller’s personal workspace if missing”

POST /api/v1/workspaces/personal

Operation
workspaces.ensure_personal
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
changing
Rate class
write

Answers

  • 200 The result

    application/json: CollaborationWorkspaceWithRole

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read one workspace with the caller’s role

Section titled “Read one workspace with the caller’s role”

GET /api/v1/workspaces/{collaborationWorkspaceId}

Operation
workspaces.get
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required

Answers

  • 200 The result

    application/json: CollaborationWorkspaceWithRole

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Change a workspace’s settings

Section titled “Change a workspace’s settings”

PATCH /api/v1/workspaces/{collaborationWorkspaceId}

Operation
workspaces.update
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required

Request body

application/json: UpdateCollaborationWorkspaceRequest

Answers

  • 200 The result

    application/json: CollaborationWorkspaceWithRole

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Delete a Shared Workspace and its conversations. Answers 202 when the workspace is closed and its data is still being removed.

Section titled “Delete a Shared Workspace and its conversations. Answers 202 when the workspace is closed and its data is still being removed.”

DELETE /api/v1/workspaces/{collaborationWorkspaceId}

Operation
workspaces.delete
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required

Request body

application/json: DeleteCollaborationWorkspaceRequest

Answers

  • 200 The result

    application/json: CollaborationWorkspaceDeletionResult

  • 202 The call was accepted and its work finishes by itself. The answer has no body.
  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the open requests to join a workspace

Section titled “List the open requests to join a workspace”

GET /api/v1/workspaces/{collaborationWorkspaceId}/access-requests

Operation
workspaces.access_requests.list
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Ask to join a Shared Workspace

Section titled “Ask to join a Shared Workspace”

POST /api/v1/workspaces/{collaborationWorkspaceId}/access-requests

Operation
workspaces.access_requests.create
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required

Answers

  • 200 The result

    application/json: WorkspaceAccessRequest

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Decline a request to join a workspace

Section titled “Decline a request to join a workspace”

DELETE /api/v1/workspaces/{collaborationWorkspaceId}/access-requests/{userId}

Operation
workspaces.access_requests.decline
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required
  • userId string in path, required

Answers

  • 200 The result

    application/json: WorkspaceAccessRequest

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Approve a request to join a workspace

Section titled “Approve a request to join a workspace”

POST /api/v1/workspaces/{collaborationWorkspaceId}/access-requests/{userId}/approve

Operation
workspaces.access_requests.approve
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required
  • userId string in path, required

Answers

  • 200 The result

    application/json: WorkspaceMembership

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the agents available in a workspace

Section titled “List the agents available in a workspace”

GET /api/v1/workspaces/{collaborationWorkspaceId}/agents

Operation
workspaces.agents.list
Accepts
sessionCookie, sessionToken
Scope
config:read
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1
  • locale string in query, optional

Answers

  • 200 The result

    application/json: CollaborationWorkspaceAgents

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read what deleting a Shared Workspace would remove

Section titled “Read what deleting a Shared Workspace would remove”

GET /api/v1/workspaces/{collaborationWorkspaceId}/deletion-impact

Operation
workspaces.deletion_impact.get
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required

Answers

  • 200 The result

    application/json: CollaborationWorkspaceDeletionImpact

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Search users who can be added to a workspace

Section titled “Search users who can be added to a workspace”

GET /api/v1/workspaces/{collaborationWorkspaceId}/member-candidates

Operation
workspaces.member_candidates.list
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1
  • q string in query, optional

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the members of a workspace

Section titled “List the members of a workspace”

GET /api/v1/workspaces/{collaborationWorkspaceId}/members

Operation
workspaces.members.list
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:read
Effect
reading
Rate class
read

Parameters

  • collaborationWorkspaceId string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Add a user to a workspace by email

Section titled “Add a user to a workspace by email”

POST /api/v1/workspaces/{collaborationWorkspaceId}/members

Operation
workspaces.members.add
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required

Request body

application/json: AddWorkspaceMemberRequest

Answers

  • 200 The result

    application/json: WorkspaceMember

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Leave a workspace

Section titled “Leave a workspace”

DELETE /api/v1/workspaces/{collaborationWorkspaceId}/members/me

Operation
workspaces.members.leave
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required

Answers

  • 200 The result

    application/json: WorkspaceMembership

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Change a member’s role in a workspace

Section titled “Change a member’s role in a workspace”

PATCH /api/v1/workspaces/{collaborationWorkspaceId}/members/{userId}

Operation
workspaces.members.update_role
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required
  • userId string in path, required

Request body

application/json: UpdateWorkspaceMemberRoleRequest

Answers

  • 200 The result

    application/json: WorkspaceMembership

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Remove a member from a workspace

Section titled “Remove a member from a workspace”

DELETE /api/v1/workspaces/{collaborationWorkspaceId}/members/{userId}

Operation
workspaces.members.remove
Accepts
sessionCookie, sessionToken
Scope
collaboration_workspace:manage
Effect
changing
Rate class
write

Parameters

  • collaborationWorkspaceId string in path, required
  • userId string in path, required

Answers

  • 200 The result

    application/json: WorkspaceMembership

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 409 CONFLICT: The request conflicts with the current state of the resource.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.