Create a site
Creates a site, the workspace unit agents and conversations live under.
Authorization
ApiKeyAuth AuthorizationBearer <token>
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1/sites" \ -H "Content-Type: application/json" \ -d '{ "name": "Demo Storefront", "platform": "shopify", "url": "https://demo-storefront.example.com" }'{ "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" }}