Draft a workspace from a description
Turns the caller's description of how they work into a proposed plan: a headline plus a shallow tree of folders, databases, pages, dashboards, and intake forms. The plan is a proposal only — nothing is created until an approved copy is applied to a workspace. Open to any authenticated caller because it runs before a workspace exists; the description is length-bounded and anything outside those bounds is a validation error.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/me/workspace-draft" \ -H "Content-Type: application/json" \ -d '{ "description": "string" }'{ "data": { "headline": "string", "nodes": [ { "type": "database", "ref": "string", "label": "string", "description": "string", "fields": [ { "key": "string", "label": "string", "kind": "text", "options": [ { "name": "string", "color": "string" } ], "relationRef": "string" } ], "records": [ { "title": "string", "data": { "property1": "string", "property2": "string" }, "content": [ "string" ] } ], "views": [ { "kind": "board", "label": "string" } ] } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Skip a legacy workspace restore claim
Declines an offered restore and reports the outcome: dismissed, the workspace deleted, or ownership transferred to another legacy member. Requires a Clerk session whose verified email matches the claim. An unknown or non-matching claim is not found and an offer already resolved another way is a conflict; skipping one that was already skipped or deleted returns the recorded outcome again.
Read the What's New watermark for a channel
Returns the caller's read watermark for one release channel, along with the releases published after it. Scoped to the authenticated account rather than a workspace, so any authenticated caller may read their own state.