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
curl -X post \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "id", "name", "description", "body", "parameters", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "format": "name" }, "description": { "type": "string" }, "body": { "type": "string" }, "parameters": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "array", "unknown" ] }, "defaultValue": { "type": "string" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "number" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "boolean" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "object" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "array", "items": {} } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type" } } ], "discriminator": { "propertyName": "type", "mapping": { "string": "#/components/schemas/stringTemplateParameter", "number": "#/components/schemas/numberTemplateParameter", "boolean": "#/components/schemas/booleanTemplateParameter", "object": "#/components/schemas/objectTemplateParameter", "array": "#/components/schemas/arrayTemplateParameter", "unknown": "#/components/schemas/unknownTemplateParameter" } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }}
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
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "array", "items": { "type": "object", "required": [ "id", "name", "description", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "format": "name" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }}
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
curl -X get \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates/%7BtemplateName%7D \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "id", "name", "description", "body", "parameters", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "format": "name" }, "description": { "type": "string" }, "body": { "type": "string" }, "parameters": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "array", "unknown" ] }, "defaultValue": { "type": "string" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "number" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "boolean" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "object" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "array", "items": {} } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type" } } ], "discriminator": { "propertyName": "type", "mapping": { "string": "#/components/schemas/stringTemplateParameter", "number": "#/components/schemas/numberTemplateParameter", "boolean": "#/components/schemas/booleanTemplateParameter", "object": "#/components/schemas/objectTemplateParameter", "array": "#/components/schemas/arrayTemplateParameter", "unknown": "#/components/schemas/unknownTemplateParameter" } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }}
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
curl -X patch \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates/%7BtemplateName%7D \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "id", "name", "description", "body", "parameters", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "format": "name" }, "description": { "type": "string" }, "body": { "type": "string" }, "parameters": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "object", "array", "unknown" ] }, "defaultValue": { "type": "string" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "number" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "boolean" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "object" } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type", "defaultValue": { "type": "array", "items": {} } } }, { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": "type" } } ], "discriminator": { "propertyName": "type", "mapping": { "string": "#/components/schemas/stringTemplateParameter", "number": "#/components/schemas/numberTemplateParameter", "boolean": "#/components/schemas/booleanTemplateParameter", "object": "#/components/schemas/objectTemplateParameter", "array": "#/components/schemas/arrayTemplateParameter", "unknown": "#/components/schemas/unknownTemplateParameter" } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }}
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
curl -X delete \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates/%7BtemplateName%7D \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
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
curl -X post \ https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/templates/%7BtemplateName%7D/expand \ -H 'Authorization: Bearer <YOUR_API_TOKEN>'
{ "type": "object", "required": [ "id", "workspaceId", "revision", "title", "cells", "createdAt", "createdBy", "timeRange", "updatedAt", "labels", "selectedDataSources", "frontMatter", "frontMatterSchema" ], "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string", "format": "base64uuid" }, "revision": { "type": "integer" }, "title": { "type": "string" }, "cells": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "id", "checked", "content" ], "properties": { "type": { "type": "string", "enum": [ "checkbox", "code", "discussion", "divider", "graph", "heading", "image", "list_item", "log", "provider", "table", "text", "timeline" ] }, "id": { "type": "string" }, "checked": { "type": "boolean" }, "content": { "type": "string" }, "formatting": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "offset" ], "properties": { "type": { "type": "string", "enum": [ "start_bold", "end_bold", "start_code", "end_code", "start_highlight", "end_highlight", "start_italics", "end_italics", "start_link", "end_link", "mention", "timestamp", "start_strikethrough", "end_strikethrough", "start_underline", "end_underline" ] }, "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset", "url" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" }, "url": { "type": "string" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset", "name", "userId" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "userId": { "type": "string" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "offset", "key" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" }, "key": { "type": "string" }, "value": { "type": "string" } } }, { "type": "object", "required": [ "type", "offset", "timestamp" ], "properties": { "type": "type", "offset": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" } } } ], "discriminator": { "propertyName": "type", "mapping": { "start_bold": "#/components/schemas/startBoldAnnotation", "end_bold": "#/components/schemas/endBoldAnnotation", "start_code": "#/components/schemas/startCodeAnnotation", "end_code": "#/components/schemas/endCodeAnnotation", "start_highlight": "#/components/schemas/startHighlightAnnotation", "end_highlight": "#/components/schemas/endHighlightAnnotation", "start_italics": "#/components/schemas/startItalicsAnnotation", "end_italics": "#/components/schemas/endItalicsAnnotation", "start_link": "#/components/schemas/startLinkAnnotation", "end_link": "#/components/schemas/endLinkAnnotation", "mention": "#/components/schemas/mentionAnnotation", "start_strikethrough": "#/components/schemas/startStrikethroughAnnotation", "end_strikethrough": "#/components/schemas/endStrikethroughAnnotation", "start_underline": "#/components/schemas/startUnderlineAnnotation", "end_underline": "#/components/schemas/endUnderlineAnnotation", "label": "#/components/schemas/labelAnnotation", "timestamp": "#/components/schemas/timestampAnnotation" } } } }, "level": { "type": "integer", "format": "int32" }, "readOnly": { "type": "boolean" } } }, { "type": "object", "required": [ "type", "id", "content" ], "properties": { "type": "type", "id": { "type": "string" }, "content": { "type": "string" }, "readOnly": { "type": "boolean" }, "syntax": { "type": "string" } } }, { "type": "object", "required": [ "type", "id", "threadId" ], "properties": { "type": "type", "id": { "type": "string" }, "readOnly": { "type": "boolean" }, "threadId": { "type": "string" } } }, { "type": "object", "required": [ "type", "id" ], "properties": { "type": "type", "id": { "type": "string" }, "readOnly": { "type": "boolean" } } }, { "type": "object", "required": [ "type", "id", "dataLinks", "graphType", "stackingType" ], "properties": { "type": "type", "id": { "type": "string" }, "dataLinks": { "type": "array", "items": { "type": "string" } }, "graphType": { "type": "string", "enum": [ "bar", "line" ] }, "readOnly": { "type": "boolean" }, "stackingType": { "type": "string", "enum": [ "none", "stacked", "percentage" ] } } }, { "type": "object", "required": [ "type", "id", "headingType", "content" ], "properties": { "type": "type", "id": { "type": "string" }, "headingType": { "type": "string", "enum": [ "h1", "h2", "h3" ] }, "content": { "type": "string" }, "formatting": "formatting", "readOnly": { "type": "boolean" } } }, { "type": "object", "required": [ "type", "id" ], "properties": { "type": "type", "url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "fileId": { "type": "string" }, "progress": { "type": "number", "format": "float" }, "readOnly": { "type": "boolean" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "preview": { "type": "string" } } }, { "type": "object", "required": [ "type", "id", "listType", "content" ], "properties": { "type": "type", "id": { "type": "string" }, "listType": { "type": "string", "enum": [ "ordered", "unordered" ] }, "content": { "type": "string" }, "formatting": "formatting", "level": { "type": "integer", "format": "int32" }, "readOnly": { "type": "boolean" }, "startNumber": { "type": "integer", "format": "int32" } } }, { "type": "object", "required": [ "type", "id", "dataLinks" ], "properties": { "type": "type", "id": { "type": "string" }, "dataLinks": { "type": "array", "items": { "type": "string" } }, "readOnly": { "type": "boolean" }, "hideSimilarValues": { "type": "boolean" }, "displayFields": { "type": "array", "items": { "type": "string" } }, "expandedIndices": { "type": "array", "items": { "type": "object", "required": [ "linkIndex", "recordIndex" ], "properties": { "linkIndex": { "type": "number", "format": "uint8" }, "recordIndex": { "type": "number", "format": "uint32" } } } }, "visibilityFilter": { "type": "string", "enum": [ "all", "selected", "highlighted" ] }, "selectedIndices": { "type": "array", "items": "items" }, "highlightedIndices": { "type": "array", "items": "items" } } }, { "type": "object", "required": [ "type", "id", "intent", "title" ], "properties": { "type": "type", "id": { "type": "string" }, "intent": { "type": "string" }, "queryData": { "type": "string" }, "response": { "type": "object", "required": [ "data", "mimeType" ], "properties": { "data": { "type": "string" }, "mimeType": { "type": "string" } } }, "output": { "type": "array", "items": "items" }, "title": { "type": "string" }, "formatting": "formatting", "readOnly": { "type": "boolean" } } }, { "type": "object", "required": [ "type", "id", "rows" ], "properties": { "type": "type", "id": { "type": "string" }, "readOnly": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": "type" } }, { "type": "object", "required": [ "type", "cell" ], "properties": { "type": "type", "cell": "cell" } } ], "discriminator": { "propertyName": "type", "mapping": { "empty": "#/components/schemas/tableCellValueEmpty", "cell": "#/components/schemas/tableCellValueCell" } } } } }, "columnDefs": { "type": "array", "items": { "type": "object", "required": [ "key", "title" ], "properties": { "key": { "type": "string" }, "title": { "type": "string" } } } } } }, { "type": "object", "required": [ "type", "id", "content" ], "properties": { "type": "type", "id": { "type": "string" }, "content": { "type": "string" }, "formatting": "formatting", "readOnly": { "type": "boolean" } } }, { "type": "object", "required": [ "type", "id", "dataLinks" ], "properties": { "type": "type", "id": { "type": "string" }, "dataLinks": { "type": "array", "items": { "type": "string" } }, "readOnly": { "type": "boolean" } } } ], "discriminator": { "propertyName": "type", "mapping": { "checkbox": "#/components/schemas/checkboxCell", "code": "#/components/schemas/codeCell", "discussion": "#/components/schemas/discussionCell", "divider": "#/components/schemas/dividerCell", "graph": "#/components/schemas/graphCell", "heading": "#/components/schemas/headingCell", "image": "#/components/schemas/imageCell", "list_item": "#/components/schemas/listItemCell", "log": "#/components/schemas/logCell", "provider": "#/components/schemas/providerCell", "table": "#/components/schemas/tableCell", "text": "#/components/schemas/textCell", "timeline": "#/components/schemas/timelineCell" } } } }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "format": "base64uuid" }, "name": { "type": "string" } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "title", "templateId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "templateId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ] }, { "allOf": [ {} ] } ], "discriminator": { "propertyName": "type", "mapping": { "user": "#/components/schemas/createdByUser", "trigger": "#/components/schemas/createdByTrigger", "unknown": "#/components/schemas/createdByUnknown" } } }, "readOnly": { "type": "boolean" }, "timeRange": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "updatedAt": { "type": "string", "format": "date-time" }, "visibility": { "type": "string", "enum": [ "public", "private" ] }, "labels": { "type": "array", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "selectedDataSources": { "type": "object", "description": "This is a mapping from the provider type to the data source selected for that type", "additionalProperties": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "proxyName": { "type": "string" } } } }, "frontMatter": { "type": "object" }, "frontMatterSchema": { "type": "array", "description": "An array (in order) of the properties for the keys inside a notebook front matter", "items": { "type": "object", "required": [ "key", "schema" ], "properties": { "key": { "type": "string" }, "schema": { "oneOf": [ { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string" }, "iconName": { "type": "string" }, "allowExtraValues": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "number", "description": "Representation of a number _value_ in the front matter." } }, "defaultValue": "defaultValue", "prefix": { "type": "string" }, "suffix": { "type": "string" } } }, { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string" }, "iconName": { "type": "string" }, "multiple": { "type": "boolean" }, "allowExtraValues": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "string" } }, "defaultValue": { "type": "string" } } }, { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string" }, "iconName": { "type": "string" }, "defaultValue": { "type": "string", "format": "date-time" } } }, { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string" }, "iconName": { "type": "string" }, "multiple": { "type": "boolean" }, "defaultValue": { "type": "object", "format": "base64uuid", "description": "Representation of a user _value_ in the front matter." } } } ], "discriminator": { "propertyName": "type", "mapping": { "number": "#/components/schemas/frontMatterNumberSchema", "string": "#/components/schemas/frontMatterStringSchema", "date_time": "#/components/schemas/frontMatterDateTimeSchema", "user": "#/components/schemas/frontMatterUserSchema" } } } } } } }}