Templates
Create a new template
POST /api/workspaces/{workspaceId}/templates
Create a new template
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
Body parameters
-
name
string name Required -
description
string Required -
body
string Required
Returns
200
OK
List all templates
GET /api/workspaces/{workspaceId}/templates
Retrieve all the templates that have been uploaded
Path parameters
-
sort_by
stringSort the resulting list by the following field (defaults to title)
-
sort_direction
stringSort the resulting list in the following direction (defaults to ascending)
Returns
200
OK
Retrieve a template
GET /api/workspaces/{workspaceId}/templates/{templateName}
Retrieves a specified template
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
-
templateName
string name RequiredName of the template
Returns
200
OK
Update a template
PATCH /api/workspaces/{workspaceId}/templates/{templateName}
Updates a specified template
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
-
templateName
string name RequiredName of the template
Body parameters
-
description
string -
body
string
Returns
200
OK
Delete a template
DELETE /api/workspaces/{workspaceId}/templates/{templateName}
Deletes a specified template
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
-
templateName
string name RequiredName of the template
Returns
200
OK
Expand the template
POST /api/workspaces/{workspaceId}/templates/{templateName}/expand
Expand the template into a notebook
Path parameters
-
workspaceId
string base64uuid RequiredThe workspace ID
-
templateName
string name RequiredName of the template
Returns
200
OK