patch_api_workspaces_workspaceId_notebooks_id

PATCH

/api/workspaces/{workspaceId}/notebooks/{id}

curl --request PATCH \
  --url http://localhost:8080/api/workspaces/example/notebooks/example \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "name": "example", "blocks": [ { "id": "example", "type": "code", "source": "example", "connectionId": "example", "outputs": [ "example" ], "executionCount": 1, "executedAt": "example" } ], "clientId": "example", "expectedVersion": 1 }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

id

required

string

Request Body^required

Media typeapplication/json

object

name

string

blocks

Array<object>

object

id

required

string

type

required

string

Allowed values: code sql markdown

source

required

string

connectionId

string

outputs

Array

executionCount

number

executedAt

string

clientId

string

expectedVersion

integer

> 0

Responses

2XX

Successful response

Media typeapplication/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}