API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
v2DeprecatedWorkspaces

Create a workspace

Provision a new Sillage workspace for an end customer.

Provisions a new Sillage workspace for an end customer. The partner_workspace_id must be unique per partner — it is your stable reference for all subsequent operations on this workspace.

Create a workspace

POST/api/v2/partner/workspaces

Request body

FieldTypeRequiredDescription
partner_workspace_idstringYesYour stable identifier for this workspace. Used in all subsequent requests. Must be unique.
end_customer_emailstringYesEmail address of the end customer who owns this workspace.
namestringYesDisplay name for the workspace.
domainstringNoPrimary domain of the end customer (e.g. acme.com). No protocol, path, or spaces.
signal_batch_frequency_hoursintegerNoHow often, in hours, detected signals are batched. Must be a positive integer. Defaults to 2.

Example request

curl -X POST "https://api.getsillage.com/api/v2/partner/workspaces" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "partner_workspace_id": "ws_123",
    "end_customer_email": "alice@acme.com",
    "name": "Acme Workspace",
    "domain": "acme.com",
    "signal_batch_frequency_hours": 2
  }'

Example response

Status: 201 Created

{
  "data": {
    "id": 101,
    "name": "Acme Workspace",
    "domain": "acme.com",
    "is_archived": false,
    "partner_workspace_id": "ws_123"
  }
}

Response fields

FieldTypeDescription
idintegerIdentifier for the workspace.
namestringDisplay name of the workspace.
domainstring or nullPrimary domain of the end customer, or null if not set.
is_archivedbooleanWhether this workspace has been archived.
partner_workspace_idstringYour partner-side identifier, echoed back where applicable.

Errors

StatusMeaning
401The master key is missing or invalid.
403The master key is not authorized to access this resource.
422Invalid request body.
429Too many requests.
500An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.

On this page