Skip to main content
POST
Create a Pages preview link

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Path Parameters

siteId
string<uuid>
required

The UUID of a site in the API key's workspace.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json
ttlMinutes
integer
Required range: 5 <= x <= 4320
workspace
string
Minimum string length: 1

Response

The request succeeded. Read the data Result field.

ok
boolean
required
data
object
required