Update workspace

Update the details of an existing workspace.

Request

PATCH https://superinterface.ai/api/cloud/workspaces/{workspaceId}

Path parameters

Parameter	Type	Description
`workspaceId`	string	ID of the workspace to update

Authentication

Include your organization API key in the request headers:

Authorization: Bearer YOUR_ORGANIZATION_API_KEY

Request Body

Parameter	Type	Required	Description
`name`	string	No	New name for workspace

Example request

curl -X PATCH "https://superinterface.ai/api/cloud/workspaces/60cfe680-fee5-49b9-b386-6a7097eb8497" \ -H "Authorization: Bearer YOUR_ORGANIZATION_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Project beta" }'

Response

Parameter	Type	Description
`workspace`	Workspace	Updated workspace

Example response

{ "workspace": { "id": "60cfe680-fee5-49b9-b386-6a7097eb8497", "name": "Project beta", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-02-15T10:30:00Z" } }

Errors

The endpoint may return the following errors:

401 Unauthorized

This error occurs if the API key is invalid or missing.

{ "error": "Unauthorized", "message": "Invalid or missing API key" }

400 Bad Request

Returned if the workspace ID is invalid or the workspace does not exist.

{ "error": "No workspace found" }