Get a site
Returns a single site by id. A cross-tenant id is a 404.
Authorization
ApiKeyAuth A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/v1/sites/string"{ "data": { "resumeButton": { "position": "left", "offsetBottom": 0, "offsetSide": 0, "offsetBottomNarrow": 0, "offsetSideNarrow": 0, "colors": { "background": "string", "icon": "string", "border": "string" }, "icon": "sparkle", "size": "sm", "radius": "none", "shadow": "none" }, "id": "string", "name": "string", "platform": "shopify", "url": "string", "siteInformation": "string", "toneOfVoice": "string", "vertical": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "autoGenerateStarters": true, "switchOnGeneratedStarters": true, "pageViewCountingEnabled": true, "storefrontCartCountingEnabled": true, "autoReadPages": true, "autoReadMinViews": 0, "tagMonitoringEnabled": true, "panelColors": { "panel": { "background": "string" }, "actions": { "fill": "string", "text": "string", "hover": "string", "border": "string" }, "visitor": { "fill": "string", "text": "string" }, "highlights": { "fill": "string", "text": "string" }, "assistant": { "text": "string" }, "links": { "color": "string" }, "suggestions": { "fill": "string", "text": "string", "border": "string" } }, "panelPosition": "left", "panelBackdrop": true, "hostedPage": { "enabled": true, "link": "string" }, "defaultAgentId": "string", "analysisState": "running" }}Create a site
Creates a site, the workspace unit agents and conversations live under.
Update a site
Replaces the site's `name`, `platform`, and `url` together, and optionally patches its AI-assistant-context fields (`siteInformation`, `toneOfVoice`, `vertical`). This does not accept a partial `name`/`platform`/`url` update: always send all three, unless the body carries only settings (the automation settings `autoGenerateStarters`, `switchOnGeneratedStarters`, `pageViewCountingEnabled`, `storefrontCartCountingEnabled`, `autoReadPages`, `autoReadMinViews`, `tagMonitoringEnabled`, the panel colours `panelColors`, the panel side and opening mode `panelPosition` and `panelBackdrop`, and the Panel reduced state button's `resumeButton`), which change those settings and nothing else. Each changed setting records its own audit entry (`autoReadPages` and `autoReadMinViews` share one, so do `panelPosition` and `panelBackdrop`, and `resumeButton` records one only when a value changed), and a body that mixes settings with other fields also records the site update. The whole body is validated before anything is written, so an invalid threshold, colour or offset changes nothing.