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": { "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" }}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.