Skip to content

Notebooks

All operations pertaining to the notebooks resource

List all notebooks

GET /api/workspaces/{workspaceId}/notebooks

Retrieves all Notebooks available to the workspace

Path parameters

  • workspaceId string base64uuid Required

    The workspace ID

Returns

  • 200

    OK

Example cURL request
curl -X get \
https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/notebooks \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'
Response schema
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"workspaceId",
"title",
"createdAt",
"createdBy",
"updatedAt",
"labels"
],
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string",
"format": "base64uuid"
},
"title": {
"type": "string"
},
"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"
}
}
},
"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"
}
}
}
}
}
}
}

Create a new notebook

POST /api/workspaces/{workspaceId}/notebooks

Create a new notebook

Path parameters

  • workspaceId string base64uuid Required

    The workspace ID

Body parameters

new notebook

  • title string Required
  • timeRange one of Required
    Possible values
    • timeRange object
      Nested attributes
      • from string date-time Required
      • to string date-time Required
    • timeRange object
      Nested attributes
      • relative integer int32 Required
  • cells array of object Required
    Possible values
    • checkboxCell object
      Nested attributes
      • type string Required
      • id string Required
      • checked boolean Required
      • content string Required
      • formatting array
        Possible values
        • startBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • url string Required
        • endLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • mentionAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • name string Required
          • userId string Required
        • startStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • labelAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • key string Required
          • value string
        • timestampAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • timestamp string date-time Required
      • level integer int32
      • readOnly boolean
    • codeCell object
      Nested attributes
      • type string Required
      • id string Required
      • content string Required
      • readOnly boolean
      • syntax string
    • discussionCell object
      Nested attributes
      • type string Required
      • id string Required
      • readOnly boolean
      • threadId string Required
    • dividerCell object
      Nested attributes
      • type string Required
      • id string Required
      • readOnly boolean
    • graphCell object
      Nested attributes
      • type string Required
      • id string Required
      • dataLinks array Required
      • graphType string Required
      • readOnly boolean
      • stackingType string Required
    • headingCell object
      Nested attributes
      • type string Required
      • id string Required
      • headingType string Required
      • content string Required
      • formatting array
        Possible values
        • startBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • url string Required
        • endLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • mentionAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • name string Required
          • userId string Required
        • startStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • labelAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • key string Required
          • value string
        • timestampAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • timestamp string date-time Required
      • readOnly boolean
    • imageCell object
      Nested attributes
      • type string Required
      • url string uri
      • id string Required
      • fileId string
      • progress number float
      • readOnly boolean
      • width integer int32
      • height integer int32
      • preview string
    • listItemCell object
      Nested attributes
      • type string Required
      • id string Required
      • listType string Required
      • content string Required
      • formatting array
        Possible values
        • startBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • url string Required
        • endLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • mentionAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • name string Required
          • userId string Required
        • startStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • labelAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • key string Required
          • value string
        • timestampAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • timestamp string date-time Required
      • level integer int32
      • readOnly boolean
      • startNumber integer int32
    • logCell object
      Nested attributes
      • type string Required
      • id string Required
      • dataLinks array Required
      • readOnly boolean
      • hideSimilarValues boolean
      • displayFields array
      • expandedIndices array
        Possible values
        • linkIndex number uint8
        • recordIndex number uint32
      • visibilityFilter string
      • selectedIndices array
        Possible values
        • linkIndex number uint8
        • recordIndex number uint32
      • highlightedIndices array
        Possible values
        • linkIndex number uint8
        • recordIndex number uint32
    • providerCell object
    • tableCell object
      Nested attributes
      • type string Required
      • id string Required
      • readOnly boolean
      • rows array Required
      • columnDefs array
        Possible values
        • key string
        • title string
    • textCell object
      Nested attributes
      • type string Required
      • id string Required
      • content string Required
      • formatting array
        Possible values
        • startBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endBoldAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endCodeAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endHighlightAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endItalicsAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • url string Required
        • endLinkAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • mentionAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • name string Required
          • userId string Required
        • startStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endStrikethroughAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • startUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • endUnderlineAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
        • labelAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • key string Required
          • value string
        • timestampAnnotation object
          Nested attributes
          • type string Required
          • offset integer int32 Required
          • timestamp string date-time Required
      • readOnly boolean
    • timelineCell object
      Nested attributes
      • type string Required
      • id string Required
      • dataLinks array Required
      • readOnly boolean
  • labels array of object
    Possible values
    • key string
    • value string
  • selectedDataSources object

    This is a mapping from the provider type to the data source selected for that type

    Nested attributes
    • name string
    • proxyName string
  • frontMatter object
  • frontMatterSchema array of object

    An array (in order) of the properties for the keys inside a notebook front matter

    Possible values
    • key string
    • schema
      Possible values
      • frontMatterNumberSchema object
        Nested attributes
        • displayName string Required
        • iconName string
        • allowExtraValues boolean
        • options array
        • defaultValue number

          Representation of a number value in the front matter.

        • prefix string
        • suffix string
      • frontMatterStringSchema object
        Nested attributes
        • displayName string Required
        • iconName string
        • multiple boolean
        • allowExtraValues boolean
        • options array
        • defaultValue string
      • frontMatterDateTimeSchema object
        Nested attributes
        • displayName string Required
        • iconName string
        • defaultValue string date-time
      • frontMatterUserSchema object
        Nested attributes
        • displayName string Required
        • iconName string
        • multiple boolean
        • defaultValue object base64uuid

          Representation of a user value in the front matter.

  • frontMatterCollections array of string

Returns

  • 200

    OK

Example cURL request
curl -X post \
https://studio.fiberplane.com/api/workspaces/%7BworkspaceId%7D/notebooks \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'
Response schema
{
"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"
}
}
}
}
}
}
}
}

Retrieve a single notebook

GET /api/notebooks/{notebookId}

Retrieves a single notebook (both its metadata and content)

Path parameters

  • notebookId string base64uuid Required

Returns

  • 200

    OK

Example cURL request
curl -X get \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'
Response schema
{
"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"
}
}
}
}
}
}
}
}

Deletes a notebook

DELETE /api/notebooks/{notebookId}

Deletes a notebook

Path parameters

  • notebookId string base64uuid Required

Returns

  • 200

    OK

Example cURL request
curl -X delete \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'

Modifies individual properties of a single notebook

PATCH /api/notebooks/{notebookId}

Modifies individual properties of a single notebook

Path parameters

  • notebookId string base64uuid Required

Body parameters

updated properties

  • visibility string

Returns

  • 200

    OK

Example cURL request
curl -X patch \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'

Create a copy of the notebook

POST /api/notebooks/{notebookId}/duplicate

Creates a copy of the specified notebook

Path parameters

  • notebookId string base64uuid Required

Body parameters

copy destination

  • title string Required
  • workspaceId string base64uuid Required

Returns

  • 200

    OK

Example cURL request
curl -X post \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D/duplicate \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'
Response schema
{
"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"
}
}
}
}
}
}
}
}

Gets the notebook as a template

GET /api/notebooks/{notebookId}/template.jsonnet

Downloads the specified notebooks as a Jsonnet template.

Path parameters

  • notebookId string base64uuid Required

Returns

  • 200

    OK

Example cURL request
curl -X get \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D/template.jsonnet \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'

Convert selected notebook cells to a snippet

GET /api/notebooks/{notebookId}/snippet.jsonnet

Convert the notebook cells to a snippet

Path parameters

  • start_cell_id string

    Cell ID where the snippet should start

  • end_cell_id string

Returns

  • 200

    OK

Example cURL request
curl -X get \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D/snippet.jsonnet \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'

Append cells to Notebook

POST /api/notebooks/{notebookId}/cells

Append the given cells to the notebook. Any cells that have their ID missing will be set on the server.

Path parameters

  • after string

    Append the provided cells after this cell. If the cell is not found it will return a 400. This parameter cannot be used together with before.

  • before string

    Append the provided cells before this cell. If the cell is not found it will return a 400. This parameter cannot be used together with after.

Returns

  • 200

    OK

Example cURL request
curl -X post \
https://studio.fiberplane.com/api/notebooks/%7BnotebookId%7D/cells \
-H 'Authorization: Bearer <YOUR_API_TOKEN>'
Response schema
{
"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": {