Decks

GET
/decks

Required scope: decks:read

Title, how many slides, who made it, when it was changed, how it is shared, and its link in the editor.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Query Parameters

query?string

Words in the title

limit?integer

Response Body

application/json

{}
POST
/decks

Required scope: decks:write

Each slide is the HTML + CSS inside one 1280×720 box (no scripts, no forms). theme_css sits above every slide; fonts are Google Fonts families with their weights (at most three). Pictures and videos must be files of this space's Assets, bound by id: <img data-wakato-asset="<asset id>" src="<url>"> — anything else is refused and nothing is saved.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
GET
/decks/{id}

Required scope: decks:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Response Body

application/json

{}
PATCH
/decks/{id}

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
DELETE
/decks/{id}

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
GET
/decks/{id}/views

Required scope: decks:read

Every person, each visit, the slides in the order they went through with seconds on each, where they stopped, whether they finished or downloaded the PDF, and who is watching now.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Query Parameters

viewer_id?string

Response Body

application/json

{}
POST
/decks/{id}/preview

Required scope: decks:write

One picture of every slide (or one slide with slide_id), and for each slide whether its words run out of the frame or are too small on a phone.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
POST
/decks/{id}/share

Required scope: decks:run

people each get a link of their own; public_link turns on one link for anyone (ask_email asks for an email first, check_email sends a code to it); pdf lets them download it; remove_people takes person links away. Nothing is sent.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
POST
/decks/{id}/media

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
POST
/decks/{id}/slides

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
PATCH
/decks/{id}/slides/{slideId}

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string
slideId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
DELETE
/decks/{id}/slides/{slideId}

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string
slideId*string

Response Body

application/json

{}
POST
/decks/{id}/slides/{slideId}/edit

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string
slideId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
POST
/decks/{id}/slides/{slideId}/move

Required scope: decks:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string
slideId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}