Notebooks¶
Endpoints for notebooks which offer an in-browser editor to create and execute code for data science analysis and modeling.
GET /api/v2/notebookCodeSnippets/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListSnippetsQuerySchema | query | ListSnippetsQuerySchema | false | Query schema for searching code nuggets. |
Example responses¶
200 Response
{
"description": "Response schema for the list of code snippets.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of code snippets.",
"items": {
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListCodeSnippetsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the list of code snippets. | ListCodeSnippetsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookCodeSnippets/tags/¶
Example responses¶
200 Response
{
"description": "Response schema for the list of code snippets tags.",
"properties": {
"tags": {
"description": "A list of tags for the code snippets.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "ListCodeSnippetsTagsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the list of code snippets tags. | ListCodeSnippetsTagsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookCodeSnippets/{snippetId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| snippetId | path | string | true | The ID of a code snippet to retrieve. |
Example responses¶
200 Response
{
"description": "CodeSnippet represents a code snippet.",
"properties": {
"code": {
"description": "The code snippet code content.",
"title": "Code",
"type": "string"
},
"description": {
"description": "The description of the code snippet.",
"title": "Description",
"type": "string"
},
"id": {
"description": "The ID of the code snippet.",
"title": "Id",
"type": "string"
},
"language": {
"description": "The programming language of the code snippet.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version of the code snippet.",
"title": "Languageversion",
"type": "string"
},
"locale": {
"description": "The language locale of the code snippet.",
"title": "Locale",
"type": "string"
},
"tags": {
"description": "A comma separated list of snippet tags.",
"title": "Tags",
"type": "string"
},
"title": {
"description": "The title of the code snippet.",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"locale",
"title",
"description",
"code",
"language",
"languageVersion"
],
"title": "CodeSnippet",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | CodeSnippet represents a code snippet. | CodeSnippet |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to delete all environment variables for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookEnvironmentVariables/{notebookId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to list environment variables for. |
Example responses¶
200 Response
{
"description": "List environment variables response schema.",
"properties": {
"data": {
"description": "List of environment variables",
"items": {
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "EnvironmentVariablesResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List environment variables response schema. | EnvironmentVariablesResponseSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookEnvironmentVariables/{notebookId}/¶
Body parameter¶
{
"description": "Create environment variables request schema.",
"properties": {
"data": {
"description": "List of environment variables to create.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "CreateEnvironmentVariablesRequestSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to create environment variables for. |
| body | body | CreateEnvironmentVariablesRequestSchema | false | none |
Example responses¶
201 Response
{
"description": "List environment variables response schema.",
"properties": {
"data": {
"description": "List of environment variables",
"items": {
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "EnvironmentVariablesResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | List environment variables response schema. | EnvironmentVariablesResponseSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID that the environment variable belongs to. |
| envVarId | path | string | true | The ID of the environment variable to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/¶
Body parameter¶
{
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID that the environment variable belongs to. |
| envVarId | path | string | true | The ID of the environment variable to update. |
| body | body | NewEnvironmentVariableSchema | false | none |
Example responses¶
200 Response
{
"description": "Environment variable schema.",
"properties": {
"assignedResourceId": {
"description": "The resource ID to which the environment variable is assigned.",
"title": "Assignedresourceid",
"type": "string"
},
"assignedResourceType": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"notebook"
],
"title": "EnvironmentVariableResourceType",
"type": "string"
}
],
"default": "notebook",
"description": "The resource type to which the environment variable is assigned."
},
"createdAt": {
"description": "The date and time when the environment variable was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created the environment variable.",
"title": "Createdby",
"type": "string"
},
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"id": {
"description": "The environment variable ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"title": "Name",
"type": "string"
},
"updatedAt": {
"description": "The date and time when the environment variable was last updated.",
"format": "date-time",
"title": "Updatedat",
"type": "string"
},
"updatedBy": {
"description": "The ID of the user who last updated the environment variable.",
"title": "Updatedby",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value",
"id",
"assignedResourceId",
"createdBy",
"createdAt"
],
"title": "EnvironmentVariableSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Environment variable schema. | EnvironmentVariableSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/¶
Example responses¶
200 Response
{
"description": "Response schema for listing execution environments.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of execution environments.",
"items": {
"properties": {
"created": {
"description": "The time the environment was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Execution environment description.",
"title": "Description",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the environment is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Execution environment ID.",
"title": "Id",
"type": "string"
},
"isBuiltIn": {
"default": false,
"description": "Whether the environment is a built-in environment supplied by DataRobot.",
"title": "Isbuiltin",
"type": "boolean"
},
"isDownloadable": {
"description": "Whether the environment is downloadable.",
"title": "Isdownloadable",
"type": "boolean"
},
"isPublic": {
"description": "Whether the environment is public.",
"title": "Ispublic",
"type": "boolean"
},
"latestSuccessfulVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"latestVersion": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"name": {
"description": "Execution environment name.",
"title": "Name",
"type": "string"
},
"programmingLanguage": {
"description": "Programming language of the environment.",
"title": "Programminglanguage",
"type": "string"
},
"requiredMetadataKeys": {
"description": "Required metadata keys.",
"items": {
"description": "Define additional parameters required to assemble a model. Model versions using this environment must define values\nfor each fieldName in the requiredMetadata.",
"properties": {
"displayName": {
"description": "A human readable name for the required field.",
"title": "Displayname",
"type": "string"
},
"fieldName": {
"description": "The required field key. This value is added as an environment variable when running custom models.",
"title": "Fieldname",
"type": "string"
}
},
"required": [
"fieldName",
"displayName"
],
"title": "RequiredMetadataKey",
"type": "object"
},
"title": "Requiredmetadatakeys",
"type": "array"
},
"useCases": {
"description": "List of use cases for the environment. This includes 'notebooks', at a minimum .",
"items": {
"type": "string"
},
"title": "Usecases",
"type": "array"
},
"username": {
"description": "The username of the user who created the environment.",
"title": "Username",
"type": "string"
}
},
"required": [
"id",
"isDownloadable",
"isPublic",
"name",
"programmingLanguage",
"created",
"latestVersion",
"latestSuccessfulVersion",
"username"
],
"title": "ExecutionEnvironmentSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing execution environments. | ExecutionEnvironmentsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/machines/¶
Returns all available environment machine options for which to run the notebook.
Example responses¶
200 Response
{
"description": "Represents a list of machine types in the system.",
"properties": {
"machines": {
"description": "List of machine types.",
"items": {
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
},
"title": "Machines",
"type": "array"
}
},
"title": "MachinesPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Represents a list of machine types in the system. | MachinesPublic |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/{environmentId}/notebooks/¶
Return list of notebooks that are using environment by environment ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| environmentId | path | string | true | Environment ID to get notebooks for. |
| ExecutionEnvironmentUsageByNotebooksQuery | query | ExecutionEnvironmentUsageByNotebooksQuery | false | Query parameters for listing notebooks using a specific execution environment. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebooks using a specific execution environment.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebooks using the environment.",
"items": {
"description": "Notebook using a specific execution environment.",
"properties": {
"createdAt": {
"description": "The time the notebook was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"createdBy": {
"description": "The username of the user who created the notebook.",
"title": "Createdby",
"type": "string"
},
"environmentVersion": {
"description": "The version of the environment used by the notebook.",
"title": "Environmentversion",
"type": "string"
},
"notebookId": {
"description": "Notebook ID.",
"title": "Notebookid",
"type": "string"
},
"notebookLastSession": {
"description": "The last time the notebook was started.",
"format": "date-time",
"title": "Notebooklastsession",
"type": "string"
},
"notebookName": {
"description": "Notebook name.",
"title": "Notebookname",
"type": "string"
},
"useCaseId": {
"description": "The use case ID of the notebook.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"notebookId",
"notebookName",
"createdAt",
"environmentVersion"
],
"title": "ExecutionEnvironmentUsageByNotebooks",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentUsageByNotebooksResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebooks using a specific execution environment. | ExecutionEnvironmentUsageByNotebooksResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/{environmentId}/versions/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| environmentId | path | string | true | Environment ID to get versions for. |
Example responses¶
200 Response
{
"description": "Response schema for listing execution environment versions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of environment versions.",
"items": {
"description": "Execution environment version schema.",
"properties": {
"buildStatus": {
"description": "Build status of the environment version. Possible values: 'success', 'failed'.",
"title": "Buildstatus",
"type": "string"
},
"created": {
"description": "The time the environment version was created.",
"format": "date-time",
"title": "Created",
"type": "string"
},
"description": {
"description": "Description of the environment version.",
"title": "Description",
"type": "string"
},
"dockerContext": {
"description": "URL for downloading the Docker context of the environment version.",
"title": "Dockercontext",
"type": "string"
},
"dockerContextSize": {
"description": "Size of the Docker context in bytes.",
"title": "Dockercontextsize",
"type": "integer"
},
"dockerImage": {
"description": "URL for downloading the Docker image of the environment version.",
"title": "Dockerimage",
"type": "string"
},
"dockerImageSize": {
"description": "Size of the Docker image in bytes.",
"title": "Dockerimagesize",
"type": "integer"
},
"environmentId": {
"description": "Execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"id": {
"description": "Execution environment version ID.",
"title": "Id",
"type": "string"
},
"imageId": {
"description": "Image ID of the environment version.",
"title": "Imageid",
"type": "string"
},
"label": {
"description": "Label of the environment version.",
"title": "Label",
"type": "string"
},
"libraries": {
"description": "List of libraries in the environment version.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"sourceDockerImageUri": {
"description": "The URI that the image environment version is based on. Basing off of the image URI is different from docker context or uploaded image-based environment versions.",
"title": "Sourcedockerimageuri",
"type": "string"
}
},
"required": [
"id",
"environmentId",
"buildStatus",
"created"
],
"title": "ExecutionEnvironmentVersionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ExecutionEnvironmentVersionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing execution environment versions. | ExecutionEnvironmentVersionsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/{notebookId}/¶
Return assigned execution environment as an EnvironmentPublic entity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to get execution environment for. |
Example responses¶
200 Response
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The public representation of an execution environment. | EnvironmentPublic |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookExecutionEnvironments/{notebookId}/¶
Sets the environment configuration for the notebook.
Body parameter¶
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to assign execution environment to. |
| body | body | ExecutionEnvironmentAssignRequest | false | none |
Example responses¶
200 Response
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The public representation of an execution environment. | EnvironmentPublic |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookExecutionEnvironments/{notebookId}/ports/¶
Remove all exposed port for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to delete all exposed ports for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookExecutionEnvironments/{notebookId}/ports/¶
List all exposed ports for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to get exposed ports for. |
Example responses¶
200 Response
{
"description": "List of exposed ports for a notebook.",
"properties": {
"data": {
"description": "List of exposed ports.",
"items": {
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
},
"title": "Data",
"type": "array"
}
},
"title": "ExposedPortListSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of exposed ports for a notebook. | ExposedPortListSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookExecutionEnvironments/{notebookId}/ports/¶
Body parameter¶
{
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to create exposed port for. |
| body | body | ExposePortSchema | false | none |
Example responses¶
201 Response
{
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Exposed port schema for a notebook. | ExposedPortSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/¶
Remove previously exposed port for a given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID for exposed port that is being deleted. |
| portId | path | string | true | Port ID that is being deleted. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/¶
Body parameter¶
{
"description": "Port update schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"title": "UpdateExposedPortSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID for exposed port that is being updated. |
| portId | path | string | true | Port ID that is being updated. |
| body | body | UpdateExposedPortSchema | false | none |
Example responses¶
200 Response
{
"description": "Exposed port schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"title": "Description",
"type": "string"
},
"id": {
"description": "Exposed port ID.",
"title": "Id",
"type": "string"
},
"notebookId": {
"description": "Notebook ID the exposed port belongs to.",
"title": "Notebookid",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
},
"url": {
"description": "URL to access the exposed port.",
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"notebookId",
"port",
"url"
],
"title": "ExposedPortSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Exposed port schema for a notebook. | ExposedPortSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookJobs/¶
Get scheduled jobs list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListScheduledJobQuery | query | ListScheduledJobQuery | false | Query parameters for listing scheduled jobs. |
Example responses¶
200 Response
{
"description": "Paginated response for notebook schedule jobs.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook schedule jobs.",
"items": {
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
},
"totalEnabledCount": {
"description": "Total number of enabled schedule jobs.",
"title": "Totalenabledcount",
"type": "integer"
}
},
"required": [
"totalEnabledCount"
],
"title": "NotebookScheduleJobsPaginated",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Paginated response for notebook schedule jobs. | NotebookScheduleJobsPaginated |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookJobs/¶
Body parameter¶
{
"description": "Request to create a new scheduled job.",
"properties": {
"enabled": {
"default": true,
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId",
"notebookId",
"schedule"
],
"title": "CreateScheduledJobRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateScheduledJobRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook schedule definition. | NotebookScheduleDefinition |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookJobs/manualRun/¶
Create a manual run.
Body parameter¶
{
"description": "Request to create a manual run for a scheduled job.",
"properties": {
"manualRunType": {
"allOf": [
{
"description": "Intentionally a subset of RunTypes above - to be used in API schemas",
"enum": [
"manual",
"pipeline"
],
"title": "ManualRunTypes",
"type": "string"
}
],
"default": "manual",
"description": "The type of manual run. Possible values are 'manual' or 'pipeline'."
},
"notebookId": {
"description": "The ID of the notebook to schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "CreateManualRunRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateManualRunRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook schedule definition. | NotebookScheduleDefinition |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookJobs/runHistory/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListScheduledRunsHistoryQuery | query | ListScheduledRunsHistoryQuery | false | Query parameters for listing scheduled runs history. |
Example responses¶
200 Response
{
"description": "Paginated response for notebook scheduled runs history.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook scheduled runs history.",
"items": {
"description": "Notebook scheduled run.",
"properties": {
"createdAt": {
"description": "The time the job was created.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"duration": {
"description": "The duration of the job in seconds.",
"title": "Duration",
"type": "integer"
},
"endTime": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtime",
"type": "string"
},
"endTimeTs": {
"description": "The time the job ended.",
"format": "date-time",
"title": "Endtimets",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Supplemental metadata for an environment.",
"properties": {
"id": {
"description": "The ID of the environment.",
"title": "Id",
"type": "string"
},
"label": {
"description": "The label of the environment.",
"title": "Label",
"type": "string"
},
"name": {
"description": "The name of the environment.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"label"
],
"title": "EnvironmentSupplementalMetadata",
"type": "object"
}
],
"description": "Environment metadata.",
"title": "Environment"
},
"id": {
"description": "The ID of the job run.",
"title": "Id",
"type": "string"
},
"jobAbortedTs": {
"description": "The time the job was aborted.",
"format": "date-time",
"title": "Jobabortedts",
"type": "string"
},
"jobCompletedTs": {
"description": "The time the job completed.",
"format": "date-time",
"title": "Jobcompletedts",
"type": "string"
},
"jobCreatedBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Jobcreatedby"
},
"jobErrorTs": {
"description": "The time the job errored.",
"format": "date-time",
"title": "Joberrorts",
"type": "string"
},
"jobStartedTs": {
"description": "The time the job started.",
"format": "date-time",
"title": "Jobstartedts",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookDeleted": {
"default": false,
"description": "Whether the notebook was deleted.",
"title": "Notebookdeleted",
"type": "boolean"
},
"notebookEnvironmentId": {
"description": "The ID of the notebook environment.",
"title": "Notebookenvironmentid",
"type": "string"
},
"notebookEnvironmentImageId": {
"description": "The ID of the notebook environment image.",
"title": "Notebookenvironmentimageid",
"type": "string"
},
"notebookEnvironmentLabel": {
"description": "The label of the notebook environment.",
"title": "Notebookenvironmentlabel",
"type": "string"
},
"notebookEnvironmentName": {
"description": "The name of the notebook environment.",
"title": "Notebookenvironmentname",
"type": "string"
},
"notebookHadErrors": {
"default": false,
"description": "Whether the notebook had errors.",
"title": "Notebookhaderrors",
"type": "boolean"
},
"notebookId": {
"description": "The ID of the notebook associated with the run.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the run.",
"title": "Notebookname",
"type": "string"
},
"notebookRevisionId": {
"description": "The ID of the notebook revision.",
"title": "Notebookrevisionid",
"type": "string"
},
"notebookRevisionName": {
"description": "The name of the notebook revision.",
"title": "Notebookrevisionname",
"type": "string"
},
"notebookRunType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"payload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Payload"
},
"revision": {
"allOf": [
{
"description": "Supplemental metadata for a revision.",
"properties": {
"id": {
"description": "The ID of the revision.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the revision.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "RevisionSupplementalMetadata",
"type": "object"
}
],
"description": "Revision metadata.",
"title": "Revision"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"scheduledJobId": {
"description": "The ID of the scheduled job.",
"title": "Scheduledjobid",
"type": "string"
},
"startTime": {
"description": "The time the job started.",
"format": "date-time",
"title": "Starttime",
"type": "string"
},
"status": {
"description": "The status of the job.",
"title": "Status",
"type": "string"
},
"title": {
"description": "The name of the schedule.",
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"createdAt",
"useCaseId",
"userId",
"orgId",
"notebookId",
"scheduledJobId",
"title",
"status",
"payload",
"notebookName",
"notebookRunType"
],
"title": "NotebookScheduledRun",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "NotebookScheduledRunsHistoryPaginated",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Paginated response for notebook scheduled runs history. | NotebookScheduledRunsHistoryPaginated |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookJobs/{notebookScheduleId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to delete. |
| DeleteScheduledJobQuery | query | DeleteScheduledJobQuery | false | Query parameters for deleting a scheduled job. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookJobs/{notebookScheduleId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to fetch. |
| ScheduledJobQuery | query | ScheduledJobQuery | false | Query parameters for a scheduled job. |
Example responses¶
200 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook schedule definition. | NotebookScheduleDefinition |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookJobs/{notebookScheduleId}/¶
Body parameter¶
{
"description": "Request to update an existing scheduled job.",
"properties": {
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule for the job.",
"title": "Schedule"
},
"title": {
"description": "The title of the scheduled job.",
"maxLength": 100,
"minLength": 1,
"title": "Title",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "UpdateScheduledJobRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to update. |
| body | body | UpdateScheduledJobRequest | false | none |
Example responses¶
200 Response
{
"description": "Notebook schedule definition.",
"properties": {
"createdBy": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who created the job.",
"title": "Createdby"
},
"enabled": {
"description": "Whether the job is enabled.",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "The ID of the scheduled job.",
"title": "Id",
"type": "string"
},
"isNotebookRunning": {
"default": false,
"description": "Whether or not the notebook is currently running (including manual runs). This accounts for notebook_path in Codespaces.",
"title": "Isnotebookrunning",
"type": "boolean"
},
"jobPayload": {
"allOf": [
{
"description": "Payload for the scheduled job.",
"properties": {
"notebookId": {
"description": "The ID of the notebook associated with the schedule.",
"title": "Notebookid",
"type": "string"
},
"notebookName": {
"description": "The name of the notebook associated with the schedule.",
"title": "Notebookname",
"type": "string"
},
"notebookPath": {
"description": "The path to the notebook in the file system if a Codespace is being used.",
"title": "Notebookpath",
"type": "string"
},
"notebookType": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of notebook."
},
"orgId": {
"description": "The ID of the organization the job is associated with.",
"title": "Orgid",
"type": "string"
},
"parameters": {
"description": "The parameters to pass to the notebook when it runs.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runType": {
"allOf": [
{
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
}
],
"description": "The run type of the job."
},
"uid": {
"description": "The ID of the user who created the job.",
"title": "Uid",
"type": "string"
},
"useCaseId": {
"description": "The ID of the use case this notebook is associated with.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the use case this notebook is associated with.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"uid",
"orgId",
"useCaseId",
"notebookId",
"notebookName"
],
"title": "ScheduledJobPayload",
"type": "object"
}
],
"description": "The payload for the job.",
"title": "Jobpayload"
},
"lastFailedRun": {
"description": "Last failed run time of the job.",
"format": "date-time",
"title": "Lastfailedrun",
"type": "string"
},
"lastRunTime": {
"description": "Calculated last run time (if it has run) by considering both failed and successful.",
"format": "date-time",
"title": "Lastruntime",
"type": "string"
},
"lastSuccessfulRun": {
"description": "Last successful run time of the job.",
"format": "date-time",
"title": "Lastsuccessfulrun",
"type": "string"
},
"nextRunTime": {
"description": "Next run time of the job.",
"format": "date-time",
"title": "Nextruntime",
"type": "string"
},
"notebook": {
"allOf": [
{
"description": "Subset of metadata that is useful for display purposes.",
"properties": {
"deleted": {
"default": false,
"description": "Whether the notebook is deleted.",
"title": "Deleted",
"type": "boolean"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"name": {
"description": "Notebook name.",
"title": "Name",
"type": "string"
},
"sessionStatus": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "Status of the notebook session."
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "Type of the notebook session."
},
"useCaseId": {
"description": "Use case ID associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "Use case name associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NotebookSupplementalMetadata",
"type": "object"
}
],
"description": "Notebook metadata.",
"title": "Notebook"
},
"notebookHasEnabledSchedule": {
"default": false,
"description": "Whether or not the notebook for this schedule has an enabled schedule - includes other schedules.",
"title": "Notebookhasenabledschedule",
"type": "boolean"
},
"notebookType": {
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
},
"permissions": {
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"runType": {
"description": "Types of runs that can be scheduled.",
"enum": [
"scheduled",
"manual",
"pipeline"
],
"title": "RunTypes",
"type": "string"
},
"schedule": {
"description": "Cron-like string to define how frequently job should be run.",
"title": "Schedule",
"type": "string"
},
"scheduleLocalized": {
"description": "Human-readable string calculated from the cron string that is translated and localized.",
"title": "Schedulelocalized",
"type": "string"
},
"title": {
"description": "Human readable name for the job that a user can create and update.",
"title": "Title",
"type": "string"
},
"userId": {
"description": "The ID of the user who created the job.",
"title": "Userid",
"type": "string"
}
},
"required": [
"id",
"enabled",
"userId",
"jobPayload"
],
"title": "NotebookScheduleDefinition",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook schedule definition. | NotebookScheduleDefinition |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookJobs/{notebookScheduleId}/cancel/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookScheduleId | path | string | true | Notebook Schedule ID to cancel running jobs for. |
| CancelScheduledJobsQuery | query | CancelScheduledJobsQuery | false | Query parameters for canceling scheduled jobs. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/clone/¶
Clone a notebook from a revision.
Body parameter¶
{
"description": "Request to clone a notebook from a revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CloneNotebookFromRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to clone as notebook. |
| body | body | CloneNotebookFromRevisionRequest | false | none |
Example responses¶
201 Response
{
"description": "Response schema for cloning a notebook from a revision.",
"properties": {
"notebookId": {
"description": "Newly cloned notebook ID.",
"title": "Notebookid",
"type": "string"
}
},
"required": [
"notebookId"
],
"title": "ClonedNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Response schema for cloning a notebook from a revision. | ClonedNotebookResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/restore/¶
Restore a notebook from a revision.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to restore notebook contents to. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookRevisions/{notebookId}/¶
Delete all revisions for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to delete revisions for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRevisions/{notebookId}/¶
List all revisions for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to list revisions for. |
| ListNotebookRevisionsQuerySchema | query | ListNotebookRevisionsQuerySchema | false | Query schema for listing notebook revisions. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebook revisions.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of notebook revisions.",
"items": {
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebookRevisionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebook revisions. | ListNotebookRevisionsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRevisions/{notebookId}/¶
Create a new revision from the given notebook's current state.
Body parameter¶
{
"description": "Request to create a new notebook revision.",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "CreateNotebookRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID to create a revision for. |
| body | body | CreateNotebookRevisionRequest | false | none |
Example responses¶
201 Response
{
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Notebook revision schema. | NotebookRevisionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookRevisions/{notebookId}/{revisionId}/¶
Delete single revision.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/¶
Get a specific revision for the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to fetch. |
Example responses¶
200 Response
{
"description": "Versioned notebook schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"id": {
"description": "Notebook ID.",
"title": "Id",
"type": "string"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"lastViewed": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision last viewed action information.",
"title": "Lastviewed"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "Organization ID.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "Notebook permissions.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "Notebook settings.",
"title": "Settings"
},
"tags": {
"description": "Notebook tags.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
},
"useCaseId": {
"description": "Use case ID.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"id",
"revisionId",
"name",
"isAuto",
"created",
"lastViewed"
],
"title": "VersionedNotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Versioned notebook schema. | VersionedNotebookSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookRevisions/{notebookId}/{revisionId}/¶
Update a revision's name.
Body parameter¶
{
"description": "Request",
"properties": {
"isAuto": {
"default": false,
"description": "Whether the revision is autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Notebook revision name.",
"minLength": 1,
"title": "Name",
"type": "string"
},
"notebookPath": {
"description": "Path to the notebook file, if using Codespaces.",
"title": "Notebookpath",
"type": "string"
}
},
"title": "UpdateNotebookRevisionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to update. |
| body | body | UpdateNotebookRevisionRequest | false | none |
Example responses¶
200 Response
{
"description": "Notebook revision schema.",
"properties": {
"created": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision creation action information.",
"title": "Created"
},
"isAuto": {
"description": "Whether the revision was autosaved.",
"title": "Isauto",
"type": "boolean"
},
"name": {
"description": "Revision name.",
"title": "Name",
"type": "string"
},
"notebookId": {
"description": "Notebook ID this revision belongs to.",
"title": "Notebookid",
"type": "string"
},
"revisionId": {
"description": "Revision ID.",
"title": "Revisionid",
"type": "string"
},
"updated": {
"allOf": [
{
"description": "Revision action information schema.",
"properties": {
"at": {
"description": "Action timestamp.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User who performed the action.",
"title": "By"
}
},
"required": [
"at"
],
"title": "RevisionActionSchema",
"type": "object"
}
],
"description": "Revision update action information.",
"title": "Updated"
}
},
"required": [
"revisionId",
"notebookId",
"name",
"isAuto",
"created"
],
"title": "NotebookRevisionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Notebook revision schema. | NotebookRevisionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/cells/¶
Get cells for a specific revision version of the given notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to fetch cells for. |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata"
],
"title": "NotebookCellCommonSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [NotebookCellCommonSchema] | false | [Schema for notebook cell.] | |
| » NotebookCellCommonSchema | NotebookCellCommonSchema | false | Schema for notebook cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the notebook cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, shell, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRevisions/{notebookId}/{revisionId}/toFile/¶
Export Notebook Revision to file.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | Notebook ID associated with revision. |
| revisionId | path | string | true | Revision ID to export as file. |
Example responses¶
200 Response
{
"type": "string"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Export notebook revision to file JSON response. | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/createAndStartCodespace/¶
Creates the Codespace and starts a session.
Body parameter¶
{
"description": "Schema for creating and starting a codespace.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "The repository to clone for the codespace.",
"title": "Clonerepository"
},
"description": {
"description": "The description of the codespace.",
"title": "Description",
"type": "string"
},
"environment": {
"allOf": [
{
"description": "Request schema for assigning an execution environment to a notebook.",
"properties": {
"environmentId": {
"description": "The execution environment ID.",
"title": "Environmentid",
"type": "string"
},
"environmentSlug": {
"description": "The execution environment slug.",
"title": "Environmentslug",
"type": "string"
},
"language": {
"description": "The programming language of the environment.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "The programming language version.",
"title": "Languageversion",
"type": "string"
},
"machineId": {
"description": "The machine ID.",
"title": "Machineid",
"type": "string"
},
"machineSlug": {
"description": "The machine slug.",
"title": "Machineslug",
"type": "string"
},
"timeToLive": {
"description": "Inactivity timeout limit.",
"maximum": 525600,
"minimum": 3,
"title": "Timetolive",
"type": "integer"
},
"versionId": {
"description": "The execution environment version ID.",
"title": "Versionid",
"type": "string"
}
},
"title": "ExecutionEnvironmentAssignRequest",
"type": "object"
}
],
"description": "The environment for the codespace.",
"title": "Environment"
},
"environmentVariables": {
"description": "The environment variables for the codespace.",
"items": {
"description": "Schema for updating environment variables.",
"properties": {
"description": {
"description": "The description of the environment variable.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the environment variable.",
"maxLength": 253,
"pattern": "^[a-zA-Z_$][\\w$]*$",
"title": "Name",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "NewEnvironmentVariableSchema",
"type": "object"
},
"title": "Environmentvariables",
"type": "array"
},
"exposedPorts": {
"description": "The exposed ports for the codespace.",
"items": {
"description": "Port creation schema for a notebook.",
"properties": {
"description": {
"description": "Description of the exposed port.",
"maxLength": 500,
"title": "Description",
"type": "string"
},
"port": {
"description": "Exposed port number.",
"title": "Port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "ExposePortSchema",
"type": "object"
},
"title": "Exposedports",
"type": "array"
},
"name": {
"default": "Untitled Codespace",
"description": "The name of the codespace.",
"title": "Name",
"type": "string"
},
"openFilePaths": {
"description": "The file paths to open in the codespace.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The settings for the codespace.",
"title": "Settings"
},
"tags": {
"description": "The tags associated with the codespace.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The ID of the use case associated with the codespace.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"useCaseId"
],
"title": "CreateAndStartCodespaceSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateAndStartCodespaceSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRuntimes/notebooks/{notebookId}/¶
Retrieves the notebook session or returns the one in the default state.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to get session data for. |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/autocomplete/¶
Autocompletes code.
Body parameter¶
{
"description": "The schema for the code completion request.",
"properties": {
"code": {
"description": "The code to complete.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition"
],
"title": "CodeCompletionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to run autocomplete for. |
| body | body | CodeCompletionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code completion result.",
"properties": {
"cursorEnd": {
"description": "The end position of the cursor in the code.",
"title": "Cursorend",
"type": "integer"
},
"cursorStart": {
"description": "The start position of the cursor in the code.",
"title": "Cursorstart",
"type": "integer"
},
"matches": {
"description": "The list of code completions.",
"items": {
"type": "string"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"matches",
"cursorStart",
"cursorEnd"
],
"title": "CodeCompletionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code completion result. | CodeCompletionResultSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/cancel/¶
Cancels execution.
Body parameter¶
{
"description": "Request schema for canceling the execution of cells in a notebook session.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"title": "CancelExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to cancel execution for. |
| body | body | CancelExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRuntimes/notebooks/{notebookId}/cells/{cellId}/dataframe/{referenceId}/¶
Gets a dataframe from a cell execution.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID the dataframe belongs to. |
| cellId | path | string | true | The cell ID the dataframe belongs to. |
| referenceId | path | integer | true | The reference ID for the dataframe. |
| SortedPaginationQuerySchema | query | SortedPaginationQuerySchema | false | Schema for query parameters for paginated requests. |
Example responses¶
200 Response
{
"description": "Response schema for getting a dataframe from a notebook session.",
"properties": {
"dataframe": {
"description": "The requested dataframe in the notebook session.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "GetDataframeResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for getting a dataframe from a notebook session. | GetDataframeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/clientActivity/¶
Reset session TTL from client, when there is a user activity.
Body parameter¶
{
"description": "Empty payload used when updating the client activity for a notebook session.",
"properties": {},
"title": "UpdateClientActivityRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID for which client activity is being acknowledged. |
| body | body | UpdateClientActivityRequest | false | none |
Example responses¶
202 Response
{
"description": "Response schema indicating successful or failed operation.",
"properties": {
"success": {
"description": "Indicates whether the operation was successful.",
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Response schema indicating success of an operation. | SuccessResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRuntimes/notebooks/{notebookId}/dataframeList/¶
Lists all dataframes for a notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to list dataframes for. |
Example responses¶
200 Response
{
"description": "Response schema for listing DataFrames in a notebook session.",
"properties": {
"dataframes": {
"description": "List of DataFrames in the notebook session.",
"items": {
"description": "Interactive variables schema. For use with results from IPython's magic `%who_ls` command.",
"properties": {
"name": {
"description": "The name of the variable.",
"title": "Name",
"type": "string"
},
"type": {
"description": "The type of the variable.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "InteractiveVariablesSchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataframesResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing DataFrames in a notebook session. | ListDataframesResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/execute/¶
Executes specific cells or the entire notebook.
Body parameter¶
{
"description": "Request payload values for executing notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to execute.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"cells": {
"description": "List of cells to execute.",
"items": {
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"generation",
"cells"
],
"title": "ExecuteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to execute cells for. |
| body | body | ExecuteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookRuntimes/notebooks/{notebookId}/executionStatus/¶
Gets execution status.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to get execution status for. |
Example responses¶
200 Response
{
"description": "Schema for the execution status of a notebook session.",
"properties": {
"cellId": {
"description": "The ID of the cell currently being executed.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution was completed.",
"title": "Executed"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
},
"status": {
"allOf": [
{
"description": "Kernel execution status.",
"enum": [
"busy",
"idle"
],
"title": "KernelExecutionStatus",
"type": "string"
}
],
"description": "The status of the kernel execution. Possible values are 'busy' or 'idle'."
},
"submitted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Info related to when the execution request was submitted.",
"title": "Submitted"
}
},
"required": [
"status",
"notebookId"
],
"title": "ExecutionStatusSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the execution status of a notebook session. | ExecutionStatusSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/inputReply/¶
Endpoint used in response to when the kernel requests input from the user.
Body parameter¶
{
"description": "The schema for the input reply request.",
"properties": {
"value": {
"description": "The value to send as a reply after kernel has requested input.",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "InputReplySchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID receiving a user's reply to a corresponding request for input. |
| body | body | InputReplySchema | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/inspect/¶
Inspects code.
Body parameter¶
{
"description": "The schema for the code inspection request.",
"properties": {
"code": {
"description": "The code to inspect.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
},
"detailLevel": {
"description": "The detail level of the inspection. Possible values are 0 and 1.",
"title": "Detaillevel",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition",
"detailLevel"
],
"title": "CodeInspectionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to run code inspection for. |
| body | body | CodeInspectionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code inspection result.",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The inspection result.",
"title": "Data",
"type": "object"
},
"found": {
"description": "True if an object was found, false otherwise.",
"title": "Found",
"type": "boolean"
}
},
"required": [
"data",
"found"
],
"title": "CodeInspectionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code inspection result. | CodeInspectionResultSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/restartKernel/¶
Restarts kernel.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to restart kernel for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/start/¶
Starts a new notebook session.
Body parameter¶
{
"description": "Schema for starting a notebook session.",
"properties": {
"cloneRepository": {
"allOf": [
{
"description": "Schema for cloning a repository.",
"properties": {
"checkoutRef": {
"description": "The branch or commit to checkout.",
"title": "Checkoutref",
"type": "string"
},
"url": {
"description": "The URL of the repository to clone.",
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CloneRepositorySchema",
"type": "object"
}
],
"description": "Automatically tells the runner to clone remote repository if it's supported as part of its environment setup flow.",
"title": "Clonerepository"
},
"isTriggeredRun": {
"default": false,
"description": "Indicates if the session is a triggered run versus an interactive run.",
"title": "Istriggeredrun",
"type": "boolean"
},
"openFilePaths": {
"description": "List of file paths to open in the notebook session.",
"items": {
"type": "string"
},
"title": "Openfilepaths",
"type": "array"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
}
},
"title": "StartNotebookSessionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to start a session for. |
| body | body | StartNotebookSessionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookRuntimes/notebooks/{notebookId}/stop/¶
Stops the notebook session.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The notebook ID to stop session for. |
Example responses¶
200 Response
{
"description": "The schema for the notebook session.",
"properties": {
"environment": {
"allOf": [
{
"description": "The public representation of an execution environment.",
"properties": {
"image": {
"allOf": [
{
"description": "This class is used to represent the public information of an image.",
"properties": {
"default": {
"default": false,
"description": "Whether the image is the default image.",
"title": "Default",
"type": "boolean"
},
"description": {
"description": "Image description.",
"title": "Description",
"type": "string"
},
"environmentId": {
"description": "Environment ID.",
"title": "Environmentid",
"type": "string"
},
"gpuOptimized": {
"default": false,
"description": "Whether the image is GPU optimized.",
"title": "Gpuoptimized",
"type": "boolean"
},
"id": {
"description": "Image ID.",
"title": "Id",
"type": "string"
},
"label": {
"description": "Image label.",
"title": "Label",
"type": "string"
},
"language": {
"description": "Image programming language.",
"title": "Language",
"type": "string"
},
"languageVersion": {
"description": "Image programming language version.",
"title": "Languageversion",
"type": "string"
},
"libraries": {
"description": "The preinstalled libraries in the image.",
"items": {
"type": "string"
},
"title": "Libraries",
"type": "array"
},
"name": {
"description": "Image name.",
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"language",
"languageVersion"
],
"title": "ImagePublic",
"type": "object"
}
],
"description": "The image of the environment.",
"title": "Image"
},
"machine": {
"allOf": [
{
"description": "Machine is a class that represents a machine type in the system.",
"properties": {
"bundleId": {
"description": "Bundle ID.",
"title": "Bundleid",
"type": "string"
},
"cpu": {
"description": "Number of CPU cores. Can be in millicores (e.g., 1000m) or cores (e.g. ,1).",
"title": "Cpu",
"type": "string"
},
"cpuCores": {
"default": 0,
"description": "CPU cores.",
"title": "Cpucores",
"type": "number"
},
"default": {
"default": false,
"description": "Is this machine type default for the environment.",
"title": "Default",
"type": "boolean"
},
"ephemeralStorage": {
"default": "10Gi",
"description": "Ephemeral storage size.",
"title": "Ephemeralstorage",
"type": "string"
},
"gpu": {
"description": "GPU cores.",
"title": "Gpu",
"type": "string"
},
"hasGpu": {
"default": false,
"description": "Whether or not this machine type has a GPU.",
"title": "Hasgpu",
"type": "boolean"
},
"id": {
"description": "Machine ID.",
"title": "Id",
"type": "string"
},
"memory": {
"description": "Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).",
"title": "Memory",
"type": "string"
},
"name": {
"description": "Machine name.",
"title": "Name",
"type": "string"
},
"ramGb": {
"default": 0,
"description": "RAM in GB.",
"title": "Ramgb",
"type": "integer"
}
},
"required": [
"id",
"name"
],
"title": "Machine",
"type": "object"
}
],
"description": "The machine of the environment.",
"title": "Machine"
},
"timeToLive": {
"description": "The inactivity timeout of the environment.",
"title": "Timetolive",
"type": "integer"
}
},
"required": [
"image",
"machine"
],
"title": "EnvironmentPublic",
"type": "object"
}
],
"description": "The environment of the notebook session.",
"title": "Environment"
},
"ephemeralSessionKey": {
"allOf": [
{
"description": "Key for an ephemeral session.",
"properties": {
"entityId": {
"description": "The ID of the entity.",
"title": "Entityid",
"type": "string"
},
"entityType": {
"allOf": [
{
"description": "Types of entities that can be associated with an ephemeral session.",
"enum": [
"CUSTOM_APP",
"CUSTOM_JOB",
"CUSTOM_MODEL",
"CUSTOM_METRIC",
"CODE_SNIPPET"
],
"title": "EphemeralSessionEntityType",
"type": "string"
}
],
"description": "The type of the entity."
}
},
"required": [
"entityType",
"entityId"
],
"title": "EphemeralSessionKey",
"type": "object"
}
],
"description": "The key of the ephemeral session. None if not an ephemeral session.",
"title": "Ephemeralsessionkey"
},
"executionCount": {
"default": 0,
"description": "The execution count of the notebook session.",
"title": "Executioncount",
"type": "integer"
},
"machineStatus": {
"allOf": [
{
"description": "This enum represents possible overall state of the machine(s) of all components of the notebook.",
"enum": [
"not_started",
"allocated",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "MachineStatuses",
"type": "string"
}
],
"description": "The status of the machine running the notebook session."
},
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"parameters": {
"description": "Parameters to use as environment variables.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"runnerStatus": {
"allOf": [
{
"description": "Runner is the same as kernel since it will manage multiple kernels in the future,\nWe can't consider kernel running if runner is not functioning and therefor this enum represents\npossible statuses of the kernel and runner sidecar functionality states.\nIn the future this will likely be renamed to kernel.",
"enum": [
"not_started",
"starting",
"running",
"restarting",
"stopping",
"stopped",
"dead",
"deleted"
],
"title": "RunnerStatuses",
"type": "string"
}
],
"description": "The status of the runner for the notebook session."
},
"sessionId": {
"description": "The ID of the notebook session.",
"title": "Sessionid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"default": "interactive",
"description": "The type of the notebook session. Possible values are interactive and triggered."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"startedBy": {
"allOf": [
{
"description": "Schema for notebook user.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"allOf": [
{
"description": "User feature flags.",
"properties": {
"DISABLE_CODESPACE_SCHEDULING": {
"description": "Whether codespace scheduling is disabled for the user.",
"title": "Disable Codespace Scheduling",
"type": "boolean"
},
"DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Disable Dummy Feature Flag For Testing",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_CODESPACES": {
"description": "Whether codespaces are disabled for the user.",
"title": "Disable Notebooks Codespaces",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SCHEDULING": {
"description": "Whether scheduling is disabled for the user.",
"title": "Disable Notebooks Scheduling",
"type": "boolean"
},
"DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": false,
"description": "Whether session port forwarding is disabled for the user.",
"title": "Disable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING": {
"description": "Dummy feature flag used for testing.",
"title": "Enable Dummy Feature Flag For Testing",
"type": "boolean"
},
"ENABLE_MMM_HOSTED_CUSTOM_METRICS": {
"description": "Whether custom metrics are enabled for the user.",
"title": "Enable Mmm Hosted Custom Metrics",
"type": "boolean"
},
"ENABLE_NOTEBOOKS": {
"description": "Whether notebooks are enabled for the user.",
"title": "Enable Notebooks",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS": {
"default": true,
"description": "Whether custom environments are enabled for the user.",
"title": "Enable Notebooks Custom Environments",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT": {
"description": "Whether filesystem management is enabled for the user.",
"title": "Enable Notebooks Filesystem Management",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_GPU": {
"description": "Whether GPU is enabled for the user.",
"title": "Enable Notebooks Gpu",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_OPEN_AI": {
"description": "Whether OpenAI is enabled for the user.",
"title": "Enable Notebooks Open Ai",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING": {
"default": true,
"description": "Whether session port forwarding is enabled for the user.",
"title": "Enable Notebooks Session Port Forwarding",
"type": "boolean"
},
"ENABLE_NOTEBOOKS_TERMINAL": {
"description": "Whether terminals are enabled for the user.",
"title": "Enable Notebooks Terminal",
"type": "boolean"
}
},
"title": "UserFeatureFlags",
"type": "object"
}
],
"description": "The feature flags of the user.",
"title": "Permissions"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "NotebookUserSchema",
"type": "object"
}
],
"description": "The user who started the notebook session.",
"title": "Startedby"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
},
"withNetworkPolicy": {
"description": "Whether the session is created with network policies.",
"title": "Withnetworkpolicy",
"type": "boolean"
}
},
"required": [
"status",
"notebookId",
"sessionId",
"environment",
"machineStatus",
"runnerStatus"
],
"title": "NotebookSessionSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook session. | NotebookSessionSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/filesystem/download/¶
Download entire file system as an archive.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download entire file system as an archive. | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/¶
Get paginated list of objects for a given path in the filesystem.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| ListFilesystemObjectsRequest | query | ListFilesystemObjectsRequest | false | We have set the limit max value to one thousand |
Example responses¶
200 Response
{
"description": "Response schema for listing filesystem objects.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of filesystem objects.",
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for DataRobot files.",
"title": "Datarobotmetadata",
"type": "object"
},
"directoryHierarchy": {
"description": "List of directories respective names and paths.",
"items": {
"description": "These are only directories\n\nThe name property can be any string or the constant/sentinel \"root\"",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"root"
],
"type": "string"
}
],
"description": "Name of the directory.",
"title": "Name"
},
"path": {
"description": "Path to the directory.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path"
],
"title": "DirHierarchyObjectSchema",
"type": "object"
},
"title": "Directoryhierarchy",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"required": [
"data",
"directoryHierarchy",
"datarobotMetadata"
],
"title": "ListFilesystemObjectsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing filesystem objects. | ListFilesystemObjectsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/copy/¶
Copy a filesystem object at a given path to a specific destination.
Body parameter¶
{
"description": "Copy filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
},
"overrideExisting": {
"default": false,
"description": "Whether to override existing files or directories.",
"title": "Overrideexisting",
"type": "boolean"
}
},
"title": "CopyFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CopyFilesystemObjectRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookSessions/{notebookId}/filesystem/objects/delete/¶
Delete a filesystem object(s) from a list of paths.
Body parameter¶
{
"description": "Delete filesystem object request schema.",
"properties": {
"paths": {
"description": "List of paths to delete.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DeleteFilesystemObjectsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | DeleteFilesystemObjectsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/download/¶
Download many files or directories from the notebook session.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| DownloadFilesystemObjectsQuery | query | DownloadFilesystemObjectsQuery | false | Query schema for downloading filesystem objects. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download many files or directories from the notebook session. | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/download/¶
Download a file or directory from the notebook session.
Body parameter¶
{
"description": "Query schema for downloading filesystem objects.",
"properties": {
"paths": {
"description": "List of paths to download.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "DownloadFilesystemObjectsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | DownloadFilesystemObjectsRequest | false | none |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download a file or directory from the notebook session. | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/metadata/¶
Get the filesystem's metadata.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| GetFilesystemObjectMetadataRequest | query | GetFilesystemObjectMetadataRequest | false | Request payload values for getting filesystem object metadata. |
Example responses¶
200 Response
{
"description": "Response schema for DataRobot filesystem metadata.",
"properties": {
"datarobotMetadata": {
"additionalProperties": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"description": "Metadata for the files.",
"title": "Datarobotmetadata",
"type": "object"
}
},
"required": [
"datarobotMetadata"
],
"title": "DRFilesystemMetadataResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for DataRobot filesystem metadata. | DRFilesystemMetadataResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookSessions/{notebookId}/filesystem/objects/metadata/¶
Update a filesystem object's metadata.
Body parameter¶
{
"description": "Request payload values for updating filesystem object metadata.",
"properties": {
"updates": {
"description": "List of updates to apply.",
"items": {
"description": "Update filesystem object metadata path and values.",
"properties": {
"metadata": {
"allOf": [
{
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
}
],
"description": "Metadata to update.",
"title": "Metadata"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"metadata"
],
"title": "UpdateFilesystemObjectMetadata",
"type": "object"
},
"title": "Updates",
"type": "array"
}
},
"title": "UpdateFilesystemObjectsMetadataRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | UpdateFilesystemObjectsMetadataRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Metadata for DataRobot files.",
"properties": {
"commandArgs": {
"description": "Command arguments for the file.",
"title": "Commandargs",
"type": "string"
}
},
"title": "DRFileMetadata",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Metadata for DataRobot files. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [DRFileMetadata] | false | [Metadata for DataRobot files.] | |
| » DRFileMetadata | DRFileMetadata | false | Metadata for DataRobot files. | |
| »» commandArgs | string | false | Command arguments for the file. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/move/¶
Move a filesystem object at a given path.
Body parameter¶
{
"description": "Move filesystem object request schema.",
"properties": {
"operations": {
"description": "List of source-destination pairs.",
"items": {
"description": "Source and destination schema for filesystem object operations.",
"properties": {
"destination": {
"description": "Destination path.",
"title": "Destination",
"type": "string"
},
"source": {
"description": "Source path.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"destination"
],
"title": "SourceDestinationSchema",
"type": "object"
},
"title": "Operations",
"type": "array"
}
},
"title": "MoveFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | MoveFilesystemObjectRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/new/¶
Create a new filesystem object (file or directory) at the given path.
Body parameter¶
{
"description": "Create a new filesystem object request schema.",
"properties": {
"isDirectory": {
"description": "Whether the filesystem object is a directory or not.",
"title": "Isdirectory",
"type": "boolean"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"isDirectory"
],
"title": "CreateFilesystemObjectRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateFilesystemObjectRequest | false | none |
Example responses¶
201 Response
{
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | This schema is used for filesystem objects (files and directories) in the filesystem. | FilesystemObjectSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/filesystem/objects/upload/¶
Upload a file or directory into the notebook session and save it under given path. If file exists by given path, it will be overridden.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"items": {
"description": "This schema is used for filesystem objects (files and directories) in the filesystem.",
"properties": {
"lastUpdatedAt": {
"description": "Last updated time of the filesystem object.",
"format": "date-time",
"title": "Lastupdatedat",
"type": "string"
},
"mediaType": {
"description": "Media type of the filesystem object.",
"title": "Mediatype",
"type": "string"
},
"name": {
"description": "Name of the filesystem object.",
"title": "Name",
"type": "string"
},
"path": {
"description": "Path to the filesystem object.",
"title": "Path",
"type": "string"
},
"sizeInBytes": {
"description": "Size of the filesystem object in bytes.",
"title": "Sizeinbytes",
"type": "integer"
},
"type": {
"allOf": [
{
"description": "Type of the filesystem object.",
"enum": [
"dir",
"file"
],
"title": "FilesystemObjectType",
"type": "string"
}
],
"description": "Type of the filesystem object. Possible values include 'dir', 'file'."
}
},
"required": [
"path",
"type",
"name"
],
"title": "FilesystemObjectSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | This schema is used for filesystem objects (files and directories) in the filesystem. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FilesystemObjectSchema] | false | [This schema is used for filesystem objects (files and directories) in the filesystem.] | |
| » FilesystemObjectSchema | FilesystemObjectSchema | false | This schema is used for filesystem objects (files and directories) in the filesystem. | |
| »» lastUpdatedAt | string(date-time) | false | Last updated time of the filesystem object. | |
| »» mediaType | string | false | Media type of the filesystem object. | |
| »» name | string | true | Name of the filesystem object. | |
| »» path | string | true | Path to the filesystem object. | |
| »» sizeInBytes | integer | false | Size of the filesystem object in bytes. | |
| »» type | FilesystemObjectType | true | Type of the filesystem object. Possible values include 'dir', 'file'. |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [dir, file] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/filesystem/objects/{subpath}/{path}/¶
Preview a file. The file path is passed as a parameter. For example: filesystem/objects/home/usr/storage/img.png/
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| subpath | path | string | true | See method level description for details. |
| path | path | string | true | See method level description for details. |
Example responses¶
200 Response
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Preview a file. | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/git/clone/¶
Body parameter¶
{
"description": "Request schema for cloning a Git repository.",
"properties": {
"url": {
"description": "URL of the Git repository to clone.",
"format": "uri",
"maxLength": 65536,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "GitCloneRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | GitCloneRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/git/clone/cancel/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/git/clone/status/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Response schema for the status of a Git clone operation.",
"properties": {
"errorMsg": {
"description": "Error message if the clone operation failed.",
"title": "Errormsg",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Status of the VCS command.",
"enum": [
"not_inited",
"running",
"finished",
"error"
],
"title": "VCSCommandStatus",
"type": "string"
}
],
"description": "Status of the Git clone operation."
}
},
"required": [
"status"
],
"title": "GitCloneStatusResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the status of a Git clone operation. | GitCloneStatusResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/kernels/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"items": {
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [KernelSchema] | false | [The schema for the notebook kernel.] | |
| » KernelSchema | KernelSchema | false | The schema for the notebook kernel. | |
| »» executionState | KernelState | true | The execution state of the kernel. | |
| »» id | string | true | The ID of the kernel. | |
| »» language | RuntimeLanguage | true | The programming language of the kernel. Possible values include 'python', 'r'. | |
| »» name | string | true | The name of the kernel. Possible values include 'python3', 'ir'. | |
| »» running | boolean | false | Whether the kernel is running. |
Enumerated Values¶
| Property | Value |
|---|---|
| executionState | [connecting, disconnected, connected, starting, idle, busy, interrupting, restarting, not_running] |
| language | [python, r, shell, markdown] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/¶
Body parameter¶
{
"description": "Request payload values for starting a kernel.",
"properties": {
"spec": {
"description": "Name of the kernel to start. Possible values include 'python3', 'ir'.",
"title": "Spec",
"type": "string"
}
},
"required": [
"spec"
],
"title": "StartKernelRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | StartKernelRequest | false | none |
Example responses¶
201 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The schema for the notebook kernel. | KernelSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to stop. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to retrieve. |
Example responses¶
200 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | KernelSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/completion/¶
Body parameter¶
{
"description": "The schema for the code completion request.",
"properties": {
"code": {
"description": "The code to complete.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition"
],
"title": "CodeCompletionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to use when requesting code completion. |
| body | body | CodeCompletionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code completion result.",
"properties": {
"cursorEnd": {
"description": "The end position of the cursor in the code.",
"title": "Cursorend",
"type": "integer"
},
"cursorStart": {
"description": "The start position of the cursor in the code.",
"title": "Cursorstart",
"type": "integer"
},
"matches": {
"description": "The list of code completions.",
"items": {
"type": "string"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"matches",
"cursorStart",
"cursorEnd"
],
"title": "CodeCompletionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code completion result. | CodeCompletionResultSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/execute/¶
Body parameter¶
{
"properties": {
"code": {
"description": "The code to execute.",
"title": "Code",
"type": "string"
}
},
"required": [
"code"
],
"title": "ExecuteCodeRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to use when executing code. |
| body | body | ExecuteCodeRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inputReply/¶
Body parameter¶
{
"description": "The schema for the input reply request.",
"properties": {
"value": {
"description": "The value to send as a reply after kernel has requested input.",
"title": "Value",
"type": "string"
}
},
"required": [
"value"
],
"title": "InputReplySchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to send input request reply to. |
| body | body | InputReplySchema | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inspect/¶
Body parameter¶
{
"description": "The schema for the code inspection request.",
"properties": {
"code": {
"description": "The code to inspect.",
"title": "Code",
"type": "string"
},
"cursorPosition": {
"description": "The position of the cursor in the code.",
"title": "Cursorposition",
"type": "integer"
},
"detailLevel": {
"description": "The detail level of the inspection. Possible values are 0 and 1.",
"title": "Detaillevel",
"type": "integer"
}
},
"required": [
"code",
"cursorPosition",
"detailLevel"
],
"title": "CodeInspectionSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to inspect. |
| body | body | CodeInspectionSchema | false | none |
Example responses¶
200 Response
{
"description": "The schema for the code inspection result.",
"properties": {
"data": {
"additionalProperties": {
"type": "string"
},
"description": "The inspection result.",
"title": "Data",
"type": "object"
},
"found": {
"description": "True if an object was found, false otherwise.",
"title": "Found",
"type": "boolean"
}
},
"required": [
"data",
"found"
],
"title": "CodeInspectionResultSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the code inspection result. | CodeInspectionResultSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/interrupt/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to interrupt. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/restart/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| kernelId | path | string | true | The kernel ID to restart. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/kernelspecs/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Schema for the Codespace's kernel information.",
"properties": {
"default": {
"description": "The default kernel. Possible values include 'python3', 'ir'.",
"title": "Default",
"type": "string"
},
"kernels": {
"description": "List of available kernels.",
"items": {
"properties": {
"displayName": {
"description": "Display name of the kernel. Possible values include 'R', 'Python 3 (ipykernel)'.",
"title": "Displayname",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "Runtime language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "Name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
}
},
"required": [
"name",
"displayName",
"language"
],
"title": "KernelSpecSchema",
"type": "object"
},
"title": "Kernels",
"type": "array"
}
},
"required": [
"default"
],
"title": "KernelSpecsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the Codespace's kernel information. | KernelSpecsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/notebook/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| NotebookOperationQuery | query | NotebookOperationQuery | false | Base query schema for notebook operations. |
Example responses¶
200 Response
{
"description": "The schema for a .ipynb notebook as part of a Codespace.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"lastExecuted": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Last executed information.",
"title": "Lastexecuted"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"generation",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NotebookFileSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for a .ipynb notebook as part of a Codespace. | NotebookFileSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/¶
Body parameter¶
{
"description": "Base schema for notebook operations.",
"properties": {
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookOperationSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | NotebookOperationSchema | false | none |
Example responses¶
201 Response
{
"description": "The schema for the newly created notebook.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"metadata": {
"description": "Metadata for the notebook.",
"title": "Metadata",
"type": "object"
},
"name": {
"description": "Name of the notebook.",
"title": "Name",
"type": "string"
},
"nbformat": {
"description": "The notebook format version.",
"title": "Nbformat",
"type": "integer"
},
"nbformatMinor": {
"description": "The notebook format minor version.",
"title": "Nbformatminor",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"nbformat",
"nbformatMinor",
"metadata"
],
"title": "NewNotebookFileSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The schema for the newly created notebook. | NewNotebookFileSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/activity/¶
Reports that the client is still working with these notebooks. UI uses it to report notebooks that are open and potentially viewed by the user. Knowing this information helps to shut down inactive notebook reconcilers/executors.
Body parameter¶
{
"description": "Request payload values for updating notebook activity.",
"properties": {
"paths": {
"description": "List of paths to update activity for.",
"items": {
"type": "string"
},
"title": "Paths",
"type": "array"
}
},
"title": "NotebookActivityRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | NotebookActivityRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| BatchCellQuery | query | BatchCellQuery | false | Base schema for batch cell queries. |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/notebook/cells/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| GetCellsQuery | query | GetCellsQuery | false | Base query schema for getting notebook cells. |
Example responses¶
200 Response
{
"description": "The schema for the notebook cells.",
"properties": {
"cells": {
"description": "List of cells in the notebook.",
"items": {
"anyOf": [
{
"description": "The schema for a code cell in the notebook.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "code",
"description": "Type of the cell."
},
"executionCount": {
"default": 0,
"description": "Execution count of the cell.",
"title": "Executioncount",
"type": "integer"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"outputs": {
"description": "Outputs of the cell.",
"items": {
"anyOf": [
{
"description": "The schema for the execute result output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"executionCount": {
"default": 0,
"description": "Execution count of the output.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "execute_result",
"default": "execute_result",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "ExecuteResultOutputSchema",
"type": "object"
},
{
"description": "The schema for the display data output in a notebook cell.",
"properties": {
"data": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{}
]
},
"description": "Data of the output.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Metadata of the output.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"const": "display_data",
"default": "display_data",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
}
},
"title": "DisplayDataOutputSchema",
"type": "object"
},
{
"description": "The schema for the stream output in a notebook cell.",
"properties": {
"name": {
"description": "Name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"const": "stream",
"default": "stream",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Text of the stream.",
"title": "Text"
}
},
"required": [
"name",
"text"
],
"title": "StreamOutputSchema",
"type": "object"
},
{
"description": "The schema for the error output in a notebook cell.",
"properties": {
"ename": {
"description": "Error name.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "Error value.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"const": "error",
"default": "error",
"description": "Type of the output.",
"title": "Outputtype",
"type": "string"
},
"traceback": {
"description": "Traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"ename",
"evalue"
],
"title": "ErrorOutputSchema",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "CodeCellSchema",
"type": "object"
},
{
"description": "The schema for a markdown cell in the notebook.",
"properties": {
"attachments": {
"description": "Attachments of the cell.",
"title": "Attachments",
"type": "object"
},
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"default": "markdown",
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "MarkdownCellSchema",
"type": "object"
},
{
"description": "The schema for cells in a notebook that are not code or markdown.",
"properties": {
"cellType": {
"description": "Type of the cell.",
"title": "Celltype",
"type": "string"
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"default": "",
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType"
],
"title": "AnyCellSchema",
"type": "object"
}
]
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
}
},
"required": [
"generation",
"cells"
],
"title": "NotebookCellsSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook cells. | NotebookCellsSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookSessions/{notebookId}/notebook/cells/¶
Body parameter¶
{
"description": "Request payload values for updating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of updated notebook cells.",
"items": {
"description": "The schema for the updated notebook cell.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id"
],
"title": "UpdateNotebookCellSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "UpdateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | UpdateCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/¶
Body parameter¶
{
"description": "Request payload values for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cells": {
"description": "List of cells to create.",
"items": {
"description": "The schema for the cells to be inserted into a notebook.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to insert the new cell.",
"title": "Aftercellid"
},
"data": {
"allOf": [
{
"description": "The schema for the notebook cell to be created.",
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell to create."
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Metadata of the cell.",
"title": "Metadata"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"cellType"
],
"title": "CreateNotebookCellSchema",
"type": "object"
}
],
"description": "The cell data to insert.",
"title": "Data"
}
},
"required": [
"afterCellId",
"data"
],
"title": "InsertCellsSchema",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cells"
],
"title": "CreateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Response schema for creating notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs of the created cells.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"actionId",
"cellIds"
],
"title": "CreateCellsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Response schema for creating notebook cells. | CreateCellsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/cancel/¶
Body parameter¶
{
"description": "Request payload values for canceling notebook cells execution.",
"properties": {
"cellIds": {
"description": "List of cell IDs to cancel execution for.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "CancelCellsExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CancelCellsExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookSessions/{notebookId}/notebook/cells/output/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| BatchCellQuery | query | BatchCellQuery | false | Base schema for batch cell queries. |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/reorder/¶
Body parameter¶
{
"description": "Request payload values for reordering notebook cells.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"cellIds": {
"description": "List of cell IDs to reorder.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"cellIds"
],
"title": "ReorderCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | ReorderCellsRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/cells/{cellId}/move/¶
Body parameter¶
{
"description": "Request payload values for moving a notebook cell.",
"properties": {
"actionId": {
"description": "Action ID of notebook update request.",
"maxLength": 64,
"title": "Actionid",
"type": "string"
},
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "ID of the cell after which to move the cell.",
"title": "Aftercellid"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"generation",
"path",
"afterCellId"
],
"title": "MoveCellRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| cellId | path | string | true | The cell ID to move. |
| body | body | MoveCellRequest | false | none |
Example responses¶
202 Response
{
"description": "Base schema for action created responses.",
"properties": {
"actionId": {
"description": "Action ID of the notebook update request.",
"title": "Actionid",
"type": "string"
}
},
"required": [
"actionId"
],
"title": "ActionCreatedResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Base schema for action created responses. | ActionCreatedResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| NotebookOperationQuery | query | NotebookOperationQuery | false | Base query schema for notebook operations. |
Example responses¶
200 Response
{
"description": "Schema for the list of DataFrames in a notebook.",
"properties": {
"dataframes": {
"description": "List of DataFrames information.",
"items": {
"description": "Schema for a single DataFrame entry.",
"properties": {
"name": {
"description": "Name of the DataFrame.",
"title": "Name",
"type": "string"
},
"type": {
"description": "Type of the DataFrame.",
"title": "Type",
"type": "string"
}
},
"required": [
"name",
"type"
],
"title": "DataFrameEntrySchema",
"type": "object"
},
"title": "Dataframes",
"type": "array"
}
},
"title": "ListDataFrameResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the list of DataFrames in a notebook. | ListDataFrameResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/notebook/dataframes/{referenceId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| referenceId | path | string | true | The reference ID for the DataFrame. |
| PaginatedDataframeQuery | query | PaginatedDataframeQuery | false | Query schema for paginated dataframe requests. |
Example responses¶
200 Response
{
"description": "Schema for the DataFrame response.",
"properties": {
"dataframe": {
"description": "The DataFrame as a string.",
"title": "Dataframe",
"type": "string"
}
},
"required": [
"dataframe"
],
"title": "DataFrameResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the DataFrame response. | DataFrameResponseSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/execute/¶
Body parameter¶
{
"description": "Request payload values for executing notebook cells.",
"properties": {
"cellIds": {
"description": "List of cell IDs to execute.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"cells": {
"description": "List of cells to execute.",
"items": {
"properties": {
"cellType": {
"allOf": [
{
"description": "Supported cell types for notebooks.",
"enum": [
"code",
"markdown"
],
"title": "SupportedCellTypes",
"type": "string"
}
],
"description": "Type of the cell."
},
"id": {
"description": "ID of the cell.",
"title": "Id",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "Contents of the cell, represented as a string.",
"title": "Source"
}
},
"required": [
"id",
"cellType",
"source"
],
"title": "NotebookCellExecData",
"type": "object"
},
"title": "Cells",
"type": "array"
},
"generation": {
"description": "Integer representing the generation of the notebook.",
"title": "Generation",
"type": "integer"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path",
"generation",
"cells"
],
"title": "ExecuteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | ExecuteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/notebook/execution/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| MultiNotebookOperationQuery | query | MultiNotebookOperationQuery | false | Base query schema for multiple notebook operations. |
Example responses¶
200 Response
{
"description": "Response schema for the notebooks execution state.",
"properties": {
"states": {
"description": "List of notebooks execution states.",
"items": {
"description": "The schema for the notebook execution state.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Notebook execution state model",
"properties": {
"executingCellId": {
"description": "The ID of the cell currently being executed.",
"title": "Executingcellid",
"type": "string"
},
"executionFinishedAt": {
"description": "The time the execution finished. This is based on the finish time of the last cell.",
"format": "date-time",
"title": "Executionfinishedat",
"type": "string"
},
"executionStartedAt": {
"description": "The time the execution started.",
"format": "date-time",
"title": "Executionstartedat",
"type": "string"
},
"inputRequest": {
"allOf": [
{
"description": "AwaitingInputState represents the state of a cell that is awaiting input from the user.",
"properties": {
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
},
"requestedAt": {
"description": "The time the input was requested.",
"format": "date-time",
"title": "Requestedat",
"type": "string"
}
},
"required": [
"requestedAt",
"prompt",
"password"
],
"title": "AwaitingInputState",
"type": "object"
}
],
"description": "The input request state of the cell.",
"title": "Inputrequest"
},
"kernelId": {
"description": "The ID of the kernel used for execution.",
"title": "Kernelid",
"type": "string"
},
"queuedCellIds": {
"description": "The IDs of the cells that are queued for execution.",
"items": {
"type": "string"
},
"title": "Queuedcellids",
"type": "array"
}
},
"title": "NotebookExecutionState",
"type": "object"
}
],
"description": "Execution state of the notebook.",
"title": "Executionstate"
},
"kernel": {
"allOf": [
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
],
"description": "Kernel assigned to the notebook.",
"title": "Kernel"
},
"kernelId": {
"description": "Kernel ID assigned to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "NotebookExecutionStateSchema",
"type": "object"
},
"title": "States",
"type": "array"
}
},
"required": [
"states"
],
"title": "NotebooksExecutionStateResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for the notebooks execution state. | NotebooksExecutionStateResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/kernel/¶
Sets kernel for a given notebook.
Body parameter¶
{
"description": "Request payload values for assigning a kernel to a notebook.",
"properties": {
"kernelId": {
"description": "ID of the kernel to assign to the notebook.",
"title": "Kernelid",
"type": "string"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "AssignNotebookKernelRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | AssignNotebookKernelRequest | false | none |
Example responses¶
200 Response
{
"description": "The schema for the notebook kernel.",
"properties": {
"executionState": {
"allOf": [
{
"description": "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY -> IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted: IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE -> BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling the stop kernel endpoint:\n DISCONNECTED (can be sent a few times) -> NOT_RUNNING (after 5s)",
"enum": [
"connecting",
"disconnected",
"connected",
"starting",
"idle",
"busy",
"interrupting",
"restarting",
"not_running"
],
"title": "KernelState",
"type": "string"
}
],
"description": "The execution state of the kernel."
},
"id": {
"description": "The ID of the kernel.",
"title": "Id",
"type": "string"
},
"language": {
"allOf": [
{
"description": "Runtime language for notebook execution in the kernel.",
"enum": [
"python",
"r",
"shell",
"markdown"
],
"title": "RuntimeLanguage",
"type": "string"
}
],
"description": "The programming language of the kernel. Possible values include 'python', 'r'."
},
"name": {
"description": "The name of the kernel. Possible values include 'python3', 'ir'.",
"title": "Name",
"type": "string"
},
"running": {
"default": false,
"description": "Whether the kernel is running.",
"title": "Running",
"type": "boolean"
}
},
"required": [
"id",
"name",
"language",
"executionState"
],
"title": "KernelSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema for the notebook kernel. | KernelSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/notebook/triggerExecution/¶
A variation of execute_notebook that automatically prepares, assigns kernel and executes the notebook in its entirety.
Body parameter¶
{
"description": "Request payload values for executing a notebook with parameters.",
"properties": {
"parameters": {
"description": "List of parameters to use as environment variables during execution.",
"items": {
"description": "Parameter that is passed to the notebook when it is run as an environment variable.",
"properties": {
"name": {
"description": "Environment variable name.",
"maxLength": 256,
"pattern": "^[a-z-A-Z0-9_]+$",
"title": "Name",
"type": "string"
},
"value": {
"description": "Environment variable value.",
"maxLength": 131072,
"title": "Value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"title": "ScheduledJobParam",
"type": "object"
},
"title": "Parameters",
"type": "array"
},
"path": {
"description": "Path to the notebook.",
"title": "Path",
"type": "string"
}
},
"required": [
"path"
],
"title": "TriggeredNotebookExecutionRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | TriggeredNotebookExecutionRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/scripts/execute/¶
Body parameter¶
{
"description": "Request payload values for running a file.",
"properties": {
"commandArgs": {
"description": "Arguments and/or flags to pass to a file execution command. For example: '--filename foo.txt -r'",
"title": "Commandargs",
"type": "string"
},
"commandType": {
"allOf": [
{
"description": "These are the command types/languages we support running files for.",
"enum": [
"python",
"bash"
],
"title": "RunnableCommandType",
"type": "string"
}
],
"description": "The type of command to be run. For example 'python'"
},
"filePath": {
"description": "Path to the file to execute.",
"title": "Filepath",
"type": "string"
}
},
"required": [
"filePath"
],
"title": "RunFileRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | RunFileRequest | false | none |
Example responses¶
200 Response
{
"description": "Response schema for executing a file.",
"properties": {
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId"
],
"title": "ExecuteFileResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for executing a file. | ExecuteFileResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/scripts/executing/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Response schema for listing executing files.",
"properties": {
"executingFiles": {
"description": "List of executing files with their kernel IDs.",
"items": {
"description": "Schema for executing file information.",
"properties": {
"filePath": {
"description": "Path to the file being executed.",
"title": "Filepath",
"type": "string"
},
"kernelId": {
"description": "ID of the kernel assigned to the file.",
"title": "Kernelid",
"type": "string"
}
},
"required": [
"kernelId",
"filePath"
],
"title": "ExecutingFileData",
"type": "object"
},
"title": "Executingfiles",
"type": "array"
}
},
"required": [
"executingFiles"
],
"title": "ExecutingFilesResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing executing files. | ExecutingFilesResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebookSessions/{notebookId}/terminals/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
Example responses¶
200 Response
{
"description": "Schema for the list of terminals in a notebook.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "List of terminals in a notebook.",
"items": {
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "TerminalsResponseSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for the list of terminals in a notebook. | TerminalsResponseSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebookSessions/{notebookId}/terminals/¶
Body parameter¶
{
"description": "Schema for creating a terminal.",
"properties": {
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateTerminalSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| body | body | CreateTerminalSchema | false | none |
Example responses¶
201 Response
{
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for a terminal. | TerminalSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| terminalId | path | string | true | The terminal ID to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/¶
Body parameter¶
{
"description": "Schema for updating a terminal.",
"properties": {
"name": {
"description": "Name to update the terminal with.",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "UpdateTerminalSchema",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook that the session belongs to. |
| terminalId | path | string | true | The terminal ID to update. |
| body | body | UpdateTerminalSchema | false | none |
Example responses¶
200 Response
{
"description": "Schema for a terminal.",
"properties": {
"createdAt": {
"description": "Creation time of the terminal.",
"format": "date-time",
"title": "Createdat",
"type": "string"
},
"name": {
"description": "Name of the terminal.",
"title": "Name",
"type": "string"
},
"terminalId": {
"description": "ID of the terminal.",
"title": "Terminalid",
"type": "string"
}
},
"required": [
"terminalId",
"name",
"createdAt"
],
"title": "TerminalSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for a terminal. | TerminalSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebooks/¶
Return list of notebooks.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ListNotebooksQuery | query | ListNotebooksQuery | false | Query options for listing notebooks in the notebooks directory. |
Example responses¶
200 Response
{
"description": "Response schema for listing notebooks.",
"properties": {
"count": {
"default": 0,
"description": "The total of paginated results.",
"title": "Count",
"type": "integer"
},
"data": {
"description": "A list of notebooks.",
"items": {
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
},
"title": "Data",
"type": "array"
},
"next": {
"description": "The URL to fetch the next batch of results.",
"title": "Next",
"type": "string"
},
"previous": {
"description": "The URL to fetch the previous batch of results.",
"title": "Previous",
"type": "string"
},
"totalCount": {
"default": 0,
"description": "The total of all results.",
"title": "Totalcount",
"type": "integer"
}
},
"title": "ListNotebooksResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for listing notebooks. | ListNotebooksResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/¶
Body parameter¶
{
"description": "Request schema for creating a notebook.",
"properties": {
"createInitialCell": {
"default": true,
"description": "Whether to create an initial cell.",
"title": "Createinitialcell",
"type": "boolean"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"name": {
"default": "Untitled Notebook",
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"title": "CreateNotebookRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateNotebookRequest | false | none |
Example responses¶
201 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for notebook metadata with additional fields. | NotebookSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/bulkLinkUseCase/¶
Body parameter¶
{
"description": "Request payload schema for bulk linking notebooks to a use case.",
"properties": {
"notebookIds": {
"description": "List of notebook IDs to link.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Notebookids",
"type": "array"
},
"source": {
"allOf": [
{
"description": "The source of the entity linking. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"classic",
"nextGen",
"api"
],
"title": "EntityLinkingSources",
"type": "string"
}
],
"description": "The source of the entity linking."
},
"useCaseId": {
"description": "The ID of the Use Case to link the notebooks to.",
"title": "Usecaseid",
"type": "string"
},
"workflow": {
"allOf": [
{
"description": "The workflow that is attaching this entity. Does not affect the operation of the API call. Only used for analytics.",
"enum": [
"migration",
"creation",
"unspecified"
],
"title": "EntityLinkingWorkflows",
"type": "string"
}
],
"description": "The workflow responsible for attaching the notebook to the Use Case."
}
},
"required": [
"notebookIds",
"useCaseId"
],
"title": "BulkLinkNotebooksToUseCaseRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | BulkLinkNotebooksToUseCaseRequest | false | none |
Example responses¶
200 Response
{
"description": "Response schema indicating successful or failed operation.",
"properties": {
"success": {
"description": "Indicates whether the operation was successful.",
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema indicating successful or failed operation. | SuccessResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebooks/filterOptions/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| FilterOptionsQuery | query | FilterOptionsQuery | false | Query options for filtering notebooks in the notebooks directory. |
Example responses¶
200 Response
{
"description": "Response schema for filter options in the notebooks directory.",
"properties": {
"owners": {
"description": "A list of possible owners to filter notebooks by.",
"items": {
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
},
"title": "Owners",
"type": "array"
},
"tags": {
"description": "A list of possible tags to filter notebooks by.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
}
},
"title": "FilterOptionsResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Response schema for filter options in the notebooks directory. | FilterOptionsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/fromFile/¶
Import Notebook from file endpoint.
Example responses¶
201 Response
{
"description": "Imported notebook information.",
"properties": {
"id": {
"description": "The ID of the created notebook.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the created notebook.",
"title": "Name",
"type": "string"
}
},
"required": [
"id"
],
"title": "ImportNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Imported notebook information. | ImportNotebookResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/fromUrl/¶
Import the notebook from the URL endpoint.
Body parameter¶
{
"description": "Request payload values for importing a notebook from a URL.",
"properties": {
"includeOutput": {
"default": true,
"description": "Whether to include the cell output of the notebook in the import.",
"title": "Includeoutput",
"type": "boolean"
},
"name": {
"description": "The name of the notebook to be created upon import.",
"title": "Name",
"type": "string"
},
"uri": {
"description": "The URL of the notebook to import.",
"title": "Uri",
"type": "string"
},
"useCaseId": {
"description": "The ID of the Use Case to import the notebook into.",
"title": "Usecaseid",
"type": "string"
}
},
"required": [
"uri"
],
"title": "ImportNotebookFromUrlRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ImportNotebookFromUrlRequest | false | none |
Example responses¶
201 Response
{
"description": "Imported notebook information.",
"properties": {
"id": {
"description": "The ID of the created notebook.",
"title": "Id",
"type": "string"
},
"name": {
"description": "The name of the created notebook.",
"title": "Name",
"type": "string"
}
},
"required": [
"id"
],
"title": "ImportNotebookResponse",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Imported notebook information. | ImportNotebookResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebooks/sharedRoles/¶
Get a lists of users who have access to each notebook and their roles on each respective notebook.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookIds | query | array[string] | true | Comma separated notebook IDs to get info of. |
Example responses¶
200 Response
{
"properties": {
"data": {
"description": "Roles data for multiple notebooks.",
"items": {
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"type": "string"
},
"roles": {
"description": "Individual roles data for the notebook.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type.",
"enum": [
"user"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object",
"x-versionadded": "v2.35"
},
"type": "array"
}
},
"required": [
"notebookId",
"roles"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"data"
],
"type": "object",
"x-versionadded": "v2.35"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Access control list for each notebook keyed by notebook ID. | NotebooksSharedRolesListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/notebooks/{notebookId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to delete. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebooks/{notebookId}/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to retrieve. |
Example responses¶
200 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook metadata with additional fields. | NotebookSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebooks/{notebookId}/¶
Body parameter¶
{
"description": "Request schema for updating a notebook.",
"properties": {
"description": {
"description": "The value to update the description of the notebook to.",
"title": "Description",
"type": "string"
},
"name": {
"description": "The value to update the name of the notebook to.",
"title": "Name",
"type": "string"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"description": "The value to update the settings of the notebook to.",
"title": "Settings"
},
"tags": {
"description": "The value to update the tags of the notebook to.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"useCaseId": {
"description": "The value to update the Use Case ID of the notebook to.",
"title": "Usecaseid",
"type": "string"
}
},
"title": "UpdateNotebookRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to update. |
| body | body | UpdateNotebookRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook metadata with additional fields.",
"properties": {
"created": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the creation of the notebook.",
"title": "Created"
},
"description": {
"description": "The description of the notebook.",
"title": "Description",
"type": "string"
},
"hasEnabledSchedule": {
"description": "Whether the notebook has an enabled schedule.",
"title": "Hasenabledschedule",
"type": "boolean"
},
"hasSchedule": {
"description": "Whether the notebook has a schedule.",
"title": "Hasschedule",
"type": "boolean"
},
"id": {
"description": "The ID of the notebook.",
"title": "Id",
"type": "string"
},
"lastViewed": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last viewed time of the notebook.",
"title": "Lastviewed"
},
"name": {
"description": "The name of the notebook.",
"title": "Name",
"type": "string"
},
"orgId": {
"description": "The ID of the organization associated with the notebook.",
"title": "Orgid",
"type": "string"
},
"permissions": {
"description": "The permissions associated with the notebook.",
"items": {
"description": "The possible allowed actions for the current user for a given Notebook.",
"enum": [
"CAN_READ",
"CAN_UPDATE",
"CAN_DELETE",
"CAN_SHARE",
"CAN_COPY",
"CAN_EXECUTE"
],
"title": "NotebookPermission",
"type": "string"
},
"type": "array"
},
"session": {
"allOf": [
{
"description": "The schema for the notebook session.",
"properties": {
"notebookId": {
"description": "The ID of the notebook.",
"title": "Notebookid",
"type": "string"
},
"sessionType": {
"allOf": [
{
"description": "Session type is either 'interactive', meaning a user has started the session via their own interactions or\n'triggered' for when a session is started programmatically.",
"enum": [
"interactive",
"triggered"
],
"title": "SessionType",
"type": "string"
}
],
"description": "The type of the notebook session."
},
"startedAt": {
"description": "The time the notebook session was started.",
"format": "date-time",
"title": "Startedat",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Possible overall states of a notebook session.",
"enum": [
"stopping",
"stopped",
"starting",
"running",
"restarting",
"dead",
"deleted"
],
"title": "NotebookSessionStatus",
"type": "string"
}
],
"description": "The status of the notebook session."
},
"userId": {
"description": "The ID of the user associated with the notebook session.",
"title": "Userid",
"type": "string"
}
},
"required": [
"status",
"notebookId"
],
"title": "NotebookSessionSharedSchema",
"type": "object"
}
],
"description": "Information about the session associated with the notebook.",
"title": "Session"
},
"settings": {
"allOf": [
{
"description": "Notebook UI settings.",
"properties": {
"hideCellFooters": {
"default": false,
"description": "Whether or not cell footers are hidden in the UI.",
"title": "Hidecellfooters",
"type": "boolean"
},
"hideCellOutputs": {
"default": false,
"description": "Whether or not cell outputs are hidden in the UI.",
"title": "Hidecelloutputs",
"type": "boolean"
},
"hideCellTitles": {
"default": false,
"description": "Whether or not cell titles are hidden in the UI.",
"title": "Hidecelltitles",
"type": "boolean"
},
"highlightWhitespace": {
"default": false,
"description": "Whether or whitespace is highlighted in the UI.",
"title": "Highlightwhitespace",
"type": "boolean"
},
"showLineNumbers": {
"default": false,
"description": "Whether or not line numbers are shown in the UI.",
"title": "Showlinenumbers",
"type": "boolean"
},
"showScrollers": {
"default": false,
"description": "Whether or not scroll bars are shown in the UI.",
"title": "Showscrollers",
"type": "boolean"
}
},
"title": "NotebookSettings",
"type": "object"
}
],
"default": {
"hide_cell_footers": false,
"hide_cell_outputs": false,
"hide_cell_titles": false,
"highlight_whitespace": false,
"show_line_numbers": false,
"show_scrollers": false
},
"description": "The settings of the notebook.",
"title": "Settings"
},
"tags": {
"description": "The tags of the notebook.",
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"tenantId": {
"description": "The tenant ID associated with the notebook.",
"title": "Tenantid",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Notebook type can be 'plain', meaning a notebook that is not part of a codespace or 'codespace' for notebooks that\nare part of a codespace. 'Ephemeral' notebooks are created for a codespace but do not persist after session\nshutdown.",
"enum": [
"plain",
"codespace",
"ephemeral"
],
"title": "NotebookType",
"type": "string"
}
],
"default": "plain",
"description": "The type of the notebook."
},
"typeTransition": {
"allOf": [
{
"description": "An enumeration.",
"enum": [
"initiated_to_codespace",
"completed"
],
"title": "NotebookTypeTransition",
"type": "string"
}
],
"description": "The type transition of the notebook."
},
"updated": {
"allOf": [
{
"description": "Notebook action signature model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who performed the action.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookActionSignature",
"type": "object"
}
],
"description": "Information about the last update of the notebook.",
"title": "Updated"
},
"useCaseId": {
"description": "The ID of the Use Case associated with the notebook.",
"title": "Usecaseid",
"type": "string"
},
"useCaseName": {
"description": "The name of the Use Case associated with the notebook.",
"title": "Usecasename",
"type": "string"
}
},
"required": [
"name",
"id",
"created",
"lastViewed"
],
"title": "NotebookSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook metadata with additional fields. | NotebookSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebooks/{notebookId}/batchClearCellsExecutionCount/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch clear cell execution count for. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/notebooks/{notebookId}/cells/¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to retrieve cells for. |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the notebook cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, shell, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/{notebookId}/cells/¶
Body parameter¶
{
"description": "Request schema for creating a notebook cell.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cell.",
"title": "Aftercellid"
},
"attachments": {
"description": "The attachments associated with the cell.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata associated with the cell.",
"title": "Metadata"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"afterCellId",
"source"
],
"title": "CreateCellRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to create cells for. |
| body | body | CreateCellRequest | false | none |
Example responses¶
200 Response
{
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | CellSchema |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebooks/{notebookId}/cells/batchClearOutput/¶
Body parameter¶
{
"description": "Request schema for batch clearing the output of notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to clear the output of.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchClearCellsOutputRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to clear all cell output of. |
| body | body | BatchClearCellsOutputRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the notebook cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, shell, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/{notebookId}/cells/batchCreate/¶
Body parameter¶
{
"description": "Request schema for batch creating notebook cells.",
"properties": {
"afterCellId": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
"FIRST"
],
"type": "string"
}
],
"description": "The ID of the cell after which to create the new cells.",
"title": "Aftercellid"
},
"cells": {
"description": "The list of cells to create.",
"items": {
"description": "Metadata for the source of a notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "Cell metadata.",
"title": "Metadata"
},
"outputs": {
"description": "Cell outputs that conform to the nbformat-based NBX schema.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "Contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
],
"title": "NotebookCellSourceMetadata",
"type": "object"
},
"title": "Cells",
"type": "array"
}
},
"required": [
"afterCellId"
],
"title": "BatchCreateCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to create cells for. |
| body | body | BatchCreateCellsRequest | false | none |
Example responses¶
201 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata of the cell.",
"title": "Metadata"
},
"outputType": {
"allOf": [
{
"description": "The possible allowed values for where/how notebook cell output is stored.",
"enum": [
"RAW_OUTPUT"
],
"title": "OutputStorageType",
"type": "string"
}
],
"default": "RAW_OUTPUT",
"description": "The type of storage used for the cell output."
},
"outputs": {
"description": "The cell outputs.",
"items": {
"anyOf": [
{
"description": "Cell stream output.",
"properties": {
"name": {
"description": "The name of the stream.",
"title": "Name",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"description": "The text of the stream.",
"title": "Text"
}
},
"required": [
"outputType",
"name",
"text"
],
"title": "APINotebookCellStreamOutput",
"type": "object"
},
{
"description": "Cell input request.",
"properties": {
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"password": {
"description": "Whether the input request is for a password.",
"title": "Password",
"type": "boolean"
},
"prompt": {
"description": "The prompt for the input request.",
"title": "Prompt",
"type": "string"
}
},
"required": [
"outputType",
"prompt",
"password"
],
"title": "APINotebookCellInputRequest",
"type": "object"
},
{
"description": "Cell error output.",
"properties": {
"ename": {
"description": "The name of the error.",
"title": "Ename",
"type": "string"
},
"evalue": {
"description": "The value of the error.",
"title": "Evalue",
"type": "string"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
},
"traceback": {
"description": "The traceback of the error.",
"items": {
"type": "string"
},
"title": "Traceback",
"type": "array"
}
},
"required": [
"outputType",
"ename",
"evalue",
"traceback"
],
"title": "APINotebookCellErrorOutput",
"type": "object"
},
{
"description": "Cell execute results output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"executionCount": {
"description": "A result's prompt number.",
"title": "Executioncount",
"type": "integer"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellExecuteResultOutput",
"type": "object"
},
{
"description": "Cell display data output.",
"properties": {
"data": {
"description": "A mime-type keyed dictionary of data.",
"title": "Data",
"type": "object"
},
"metadata": {
"description": "Cell output metadata.",
"title": "Metadata",
"type": "object"
},
"outputType": {
"description": "Type of cell output. This is a superset of the permitted values for \"output_type\" in the nbformat v4 schema.\n\nReferences:\n- https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs\n- https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406\n- services.runner.kernel.KernelMessageType",
"enum": [
"execute_result",
"stream",
"display_data",
"error",
"pyout",
"pyerr",
"input_request"
],
"title": "OutputType",
"type": "string"
}
},
"required": [
"outputType",
"data",
"metadata"
],
"title": "APINotebookCellDisplayDataOutput",
"type": "object"
}
]
},
"title": "Outputs",
"type": "array"
},
"source": {
"description": "The contents of the cell, represented as a string.",
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"metadata",
"cellId",
"md5"
],
"title": "CellSchema",
"type": "object"
},
"type": "array"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Schema for notebook cell. | Inline |
Response Schema¶
Status Code 201
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CellSchema] | false | [Schema for notebook cell.] | |
| » CellSchema | CellSchema | false | Schema for notebook cell. | |
| »» attachments | object | false | Cell attachments. | |
| »» cellId | string | true | The ID of the cell. | |
| »» executed | NotebookTimestampInfo | false | The timestamp of when the cell was executed. | |
| »»» at | string(date-time) | true | Timestamp of the action. | |
| »»» by | UserInfo | true | User info of the actor who caused the action to occur. | |
| »»»» activated | boolean | false | Whether the user is activated. | |
| »»»» firstName | string | false | The first name of the user. | |
| »»»» gravatarHash | string | false | The gravatar hash of the user. | |
| »»»» id | string | true | The ID of the user. | |
| »»»» lastName | string | false | The last name of the user. | |
| »»»» orgId | string | false | The ID of the organization the user belongs to. | |
| »»»» tenantPhase | string | false | The tenant phase of the user. | |
| »»»» username | string | false | The username of the user. | |
| »» executionCount | integer | false | The execution count of the cell relative to other cells in the current session. | |
| »» executionId | string | false | The ID of the execution. | |
| »» executionTimeMillis | integer | false | The execution time of the cell in milliseconds. | |
| »» md5 | string | true | The MD5 hash of the cell. | |
| »» metadata | NotebookCellMetadata | true | The metadata of the cell. | |
| »»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» aggregation | string | false | Aggregation function for the axis. | |
| »»»»»» color | string | false | Color for the axis. | |
| »»»»»» hideGrid | boolean | false | Whether to hide the grid lines on the axis. | |
| »»»»»» hideInTooltip | boolean | false | Whether to hide the axis in the tooltip. | |
| »»»»»» hideLabel | boolean | false | Whether to hide the axis label. | |
| »»»»»» key | string | false | Key for the axis. | |
| »»»»»» label | string | false | Label for the axis. | |
| »»»»»» position | string | false | Position of the axis. | |
| »»»»»» showPointMarkers | boolean | false | Whether to show point markers on the axis. | |
| »»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»» data | object | false | The data associated with the cell chart. | |
| »»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»» chartType | string | false | Type of the chart. | |
| »»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»» title | string | false | Title of the chart. | |
| »»» collapsed | boolean | false | Whether the cell's output is collapsed/expanded. | |
| »»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»» metricId | string | true | The ID of the custom metric. | |
| »»»» metricName | string | false | The name of the custom metric. | |
| »»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» hour | [anyOf] | true | The hour(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» minute | [anyOf] | true | The minute(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» month | [anyOf] | true | The month(s) to run the schedule. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | integer | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» dataframeViewOptions | object | false | Dataframe cell view options and metadata. | |
| »»» datarobot | NotebookCellDataRobotMetadata | false | Metadata specific to DataRobot's notebooks and notebook environment. | |
| »»»» chartSettings | NotebookChartCellMetadata | false | Chart cell view options and metadata. | |
| »»»»» axis | NotebookChartCellAxis | false | Axis settings. | |
| »»»»»» x | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»»» y | NotebookChartCellAxisSettings | false | Chart cell axis settings. | |
| »»»»» data | object | false | The data associated with the cell chart. | |
| »»»»» dataframeId | string | false | The ID of the dataframe associated with the cell chart. | |
| »»»»» viewOptions | NotebookChartCellViewOptions | false | Chart cell view options. | |
| »»»»»» chartType | string | false | Type of the chart. | |
| »»»»»» showLegend | boolean | false | Whether to show the chart legend. | |
| »»»»»» showTitle | boolean | false | Whether to show the chart title. | |
| »»»»»» showTooltip | boolean | false | Whether to show the chart tooltip. | |
| »»»»»» title | string | false | Title of the chart. | |
| »»»» customLlmMetricSettings | NotebookCustomLlmMetricCellMetadata | false | Custom LLM metric cell metadata. | |
| »»»»» metricId | string | true | The ID of the custom LLM metric. | |
| »»»»» metricName | string | true | The name of the custom LLM metric. | |
| »»»»» playgroundId | string | true | The ID of the playground associated with the custom LLM metric. | |
| »»»» customMetricSettings | NotebookCustomMetricCellMetadata | false | Custom metric cell metadata. | |
| »»»»» deploymentId | string | true | The ID of the deployment associated with the custom metric. | |
| »»»»» metricId | string | true | The ID of the custom metric. | |
| »»»»» metricName | string | false | The name of the custom metric. | |
| »»»»» schedule | Schedule | false | The schedule associated with the custom metric. | |
| »»»»»» dayOfMonth | [anyOf] | true | The day(s) of the month to run the schedule. | |
| »»»»»» dayOfWeek | [anyOf] | true | The day(s) of the week to run the schedule. | |
| »»»»»» hour | [anyOf] | true | The hour(s) to run the schedule. | |
| »»»»»» minute | [anyOf] | true | The minute(s) to run the schedule. | |
| »»»»»» month | [anyOf] | true | The month(s) to run the schedule. | |
| »»»» dataframeViewOptions | object | false | DataFrame view options and metadata. | |
| »»»» disableRun | boolean | false | Whether to disable the run button in the cell. | |
| »»»» executionTimeMillis | integer | false | Execution time of the cell in milliseconds. | |
| »»»» hideCode | boolean | false | Whether to hide the code in the cell. | |
| »»»» hideResults | boolean | false | Whether to hide the results in the cell. | |
| »»»» language | Language | false | An enumeration. | |
| »»» disableRun | boolean | false | Whether or not the cell is disabled in the UI. | |
| »»» hideCode | boolean | false | Whether or not code is hidden in the UI. | |
| »»» hideResults | boolean | false | Whether or not results are hidden in the UI. | |
| »»» jupyter | JupyterCellMetadata | false | Jupyter metadata. | |
| »»»» outputsHidden | boolean | false | Whether the cell's outputs are hidden. | |
| »»»» sourceHidden | boolean | false | Whether the cell's source is hidden. | |
| »»» name | string | false | Name of the notebook cell. | |
| »»» scrolled | any | false | Whether the cell's output is scrolled, unscrolled, or autoscrolled. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | boolean | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» anonymous | string | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» outputType | OutputStorageType | false | The type of storage used for the cell output. | |
| »» outputs | [anyOf] | false | The cell outputs. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellStreamOutput | false | Cell stream output. | |
| »»»» name | string | true | The name of the stream. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» text | any | true | The text of the stream. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | [string] | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellInputRequest | false | Cell input request. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» password | boolean | true | Whether the input request is for a password. | |
| »»»» prompt | string | true | The prompt for the input request. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellErrorOutput | false | Cell error output. | |
| »»»» ename | string | true | The name of the error. | |
| »»»» evalue | string | true | The value of the error. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
|
| »»»» traceback | [string] | true | The traceback of the error. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellExecuteResultOutput | false | Cell execute results output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» executionCount | integer | false | A result's prompt number. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»» anonymous | APINotebookCellDisplayDataOutput | false | Cell display data output. | |
| »»»» data | object | true | A mime-type keyed dictionary of data. | |
| »»»» metadata | object | true | Cell output metadata. | |
| »»»» outputType | OutputType | true | Type of cell output. This is a superset of the permitted values for "output_type" in the nbformat v4 schema. References: - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406 - services.runner.kernel.KernelMessageType |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» source | string | true | The contents of the cell, represented as a string. |
Enumerated Values¶
| Property | Value |
|---|---|
| language | [dataframe, markdown, python, r, shell, scala, sas, custommetric] |
| anonymous | auto |
| outputType | RAW_OUTPUT |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
| outputType | [execute_result, stream, display_data, error, pyout, pyerr, input_request] |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/notebooks/{notebookId}/cells/batchDelete/¶
Body parameter¶
{
"description": "Request schema for batch deleting notebook cells.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to delete.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
}
},
"required": [
"cellIds"
],
"title": "BatchDeleteCellsRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch delete cells for. |
| body | body | BatchDeleteCellsRequest | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/notebooks/{notebookId}/cells/batchUpdateMetadata/¶
Body parameter¶
{
"description": "Request schema for batch updating notebook cells metadata.",
"properties": {
"cellIds": {
"description": "The IDs of the cells to update.",
"items": {
"type": "string"
},
"title": "Cellids",
"type": "array"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "Dataframe cell view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"datarobot": {
"allOf": [
{
"description": "A custom namespaces for all DataRobot-specific information",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {
"description": "The ID of the playground associated with the custom LLM metric.",
"title": "Playgroundid",
"type": "string"
}
},
"required": [
"metricId",
"playgroundId",
"metricName"
],
"title": "NotebookCustomLlmMetricCellMetadata",
"type": "object"
}
],
"description": "Custom LLM metric cell metadata.",
"title": "Customllmmetricsettings"
},
"customMetricSettings": {
"allOf": [
{
"description": "Custom metric cell metadata.",
"properties": {
"deploymentId": {
"description": "The ID of the deployment associated with the custom metric.",
"title": "Deploymentid",
"type": "string"
},
"metricId": {
"description": "The ID of the custom metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom metric.",
"title": "Metricname",
"type": "string"
},
"schedule": {
"allOf": [
{
"description": "Data class that represents a cron schedule.",
"properties": {
"dayOfMonth": {
"description": "The day(s) of the month to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofmonth",
"type": "array"
},
"dayOfWeek": {
"description": "The day(s) of the week to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Dayofweek",
"type": "array"
},
"hour": {
"description": "The hour(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Hour",
"type": "array"
},
"minute": {
"description": "The minute(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Minute",
"type": "array"
},
"month": {
"description": "The month(s) to run the schedule.",
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"title": "Month",
"type": "array"
}
},
"required": [
"minute",
"hour",
"dayOfMonth",
"month",
"dayOfWeek"
],
"title": "Schedule",
"type": "object"
}
],
"description": "The schedule associated with the custom metric.",
"title": "Schedule"
}
},
"required": [
"metricId",
"deploymentId"
],
"title": "NotebookCustomMetricCellMetadata",
"type": "object"
}
],
"description": "Custom metric cell metadata.",
"title": "Custommetricsettings"
},
"dataframeViewOptions": {
"description": "DataFrame view options and metadata.",
"title": "Dataframeviewoptions",
"type": "object"
},
"disableRun": {
"default": false,
"description": "Whether to disable the run button in the cell.",
"title": "Disablerun",
"type": "boolean"
},
"executionTimeMillis": {
"description": "Execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"hideCode": {
"default": false,
"description": "Whether to hide the code in the cell.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether to hide the results in the cell.",
"title": "Hideresults",
"type": "boolean"
},
"language": {
"description": "An enumeration.",
"enum": [
"dataframe",
"markdown",
"python",
"r",
"shell",
"scala",
"sas",
"custommetric"
],
"title": "Language",
"type": "string"
}
},
"title": "NotebookCellDataRobotMetadata",
"type": "object"
}
],
"description": "Metadata specific to DataRobot's notebooks and notebook environment.",
"title": "Datarobot"
},
"disableRun": {
"default": false,
"description": "Whether or not the cell is disabled in the UI.",
"title": "Disablerun",
"type": "boolean"
},
"hideCode": {
"default": false,
"description": "Whether or not code is hidden in the UI.",
"title": "Hidecode",
"type": "boolean"
},
"hideResults": {
"default": false,
"description": "Whether or not results are hidden in the UI.",
"title": "Hideresults",
"type": "boolean"
},
"jupyter": {
"allOf": [
{
"description": "The schema for the Jupyter cell metadata.",
"properties": {
"outputsHidden": {
"default": false,
"description": "Whether the cell's outputs are hidden.",
"title": "Outputshidden",
"type": "boolean"
},
"sourceHidden": {
"default": false,
"description": "Whether the cell's source is hidden.",
"title": "Sourcehidden",
"type": "boolean"
}
},
"title": "JupyterCellMetadata",
"type": "object"
}
],
"description": "Jupyter metadata.",
"title": "Jupyter"
},
"name": {
"description": "Name of the notebook cell.",
"title": "Name",
"type": "string"
},
"scrolled": {
"anyOf": [
{
"type": "boolean"
},
{
"enum": [
"auto"
],
"type": "string"
}
],
"default": "auto",
"description": "Whether the cell's output is scrolled, unscrolled, or autoscrolled.",
"title": "Scrolled"
}
},
"title": "NotebookCellMetadata",
"type": "object"
}
],
"description": "The metadata to update the cells with.",
"title": "Metadata"
}
},
"required": [
"cellIds",
"metadata"
],
"title": "BatchUpdateCellsMetadataRequest",
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| notebookId | path | string | true | The ID of the notebook to batch update cell metadata for. |
| body | body | BatchUpdateCellsMetadataRequest | false | none |
Example responses¶
200 Response
{
"items": {
"description": "Schema for notebook cell.",
"properties": {
"attachments": {
"description": "Cell attachments.",
"title": "Attachments",
"type": "object"
},
"cellId": {
"description": "The ID of the cell.",
"title": "Cellid",
"type": "string"
},
"executed": {
"allOf": [
{
"description": "Notebook usage info model that holds the information about when and who performed action on a notebook.",
"properties": {
"at": {
"description": "Timestamp of the action.",
"format": "date-time",
"title": "At",
"type": "string"
},
"by": {
"allOf": [
{
"description": "User information.",
"properties": {
"activated": {
"default": true,
"description": "Whether the user is activated.",
"title": "Activated",
"type": "boolean"
},
"firstName": {
"description": "The first name of the user.",
"title": "Firstname",
"type": "string"
},
"gravatarHash": {
"description": "The gravatar hash of the user.",
"title": "Gravatarhash",
"type": "string"
},
"id": {
"description": "The ID of the user.",
"title": "Id",
"type": "string"
},
"lastName": {
"description": "The last name of the user.",
"title": "Lastname",
"type": "string"
},
"orgId": {
"description": "The ID of the organization the user belongs to.",
"title": "Orgid",
"type": "string"
},
"tenantPhase": {
"description": "The tenant phase of the user.",
"title": "Tenantphase",
"type": "string"
},
"username": {
"description": "The username of the user.",
"title": "Username",
"type": "string"
}
},
"required": [
"id"
],
"title": "UserInfo",
"type": "object"
}
],
"description": "User info of the actor who caused the action to occur.",
"title": "By"
}
},
"required": [
"at",
"by"
],
"title": "NotebookTimestampInfo",
"type": "object"
}
],
"description": "The timestamp of when the cell was executed.",
"title": "Executed"
},
"executionCount": {
"description": "The execution count of the cell relative to other cells in the current session.",
"title": "Executioncount",
"type": "integer"
},
"executionId": {
"description": "The ID of the execution.",
"title": "Executionid",
"type": "string"
},
"executionTimeMillis": {
"description": "The execution time of the cell in milliseconds.",
"title": "Executiontimemillis",
"type": "integer"
},
"md5": {
"description": "The MD5 hash of the cell.",
"title": "Md5",
"type": "string"
},
"metadata": {
"allOf": [
{
"description": "The schema for the notebook cell metadata.",
"properties": {
"chartSettings": {
"allOf": [
{
"description": "Chart cell metadata.",
"properties": {
"axis": {
"allOf": [
{
"description": "Chart cell axis settings per axis.",
"properties": {
"x": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
},
"y": {
"description": "Chart cell axis settings.",
"properties": {
"aggregation": {
"description": "Aggregation function for the axis.",
"title": "Aggregation",
"type": "string"
},
"color": {
"description": "Color for the axis.",
"title": "Color",
"type": "string"
},
"hideGrid": {
"default": false,
"description": "Whether to hide the grid lines on the axis.",
"title": "Hidegrid",
"type": "boolean"
},
"hideInTooltip": {
"default": false,
"description": "Whether to hide the axis in the tooltip.",
"title": "Hideintooltip",
"type": "boolean"
},
"hideLabel": {
"default": false,
"description": "Whether to hide the axis label.",
"title": "Hidelabel",
"type": "boolean"
},
"key": {
"description": "Key for the axis.",
"title": "Key",
"type": "string"
},
"label": {
"description": "Label for the axis.",
"title": "Label",
"type": "string"
},
"position": {
"description": "Position of the axis.",
"title": "Position",
"type": "string"
},
"showPointMarkers": {
"default": false,
"description": "Whether to show point markers on the axis.",
"title": "Showpointmarkers",
"type": "boolean"
}
},
"title": "NotebookChartCellAxisSettings",
"type": "object"
}
},
"title": "NotebookChartCellAxis",
"type": "object"
}
],
"description": "Axis settings.",
"title": "Axis"
},
"data": {
"description": "The data associated with the cell chart.",
"title": "Data",
"type": "object"
},
"dataframeId": {
"description": "The ID of the dataframe associated with the cell chart.",
"title": "Dataframeid",
"type": "string"
},
"viewOptions": {
"allOf": [
{
"description": "Chart cell view options.",
"properties": {
"chartType": {
"description": "Type of the chart.",
"title": "Charttype",
"type": "string"
},
"showLegend": {
"default": false,
"description": "Whether to show the chart legend.",
"title": "Showlegend",
"type": "boolean"
},
"showTitle": {
"default": false,
"description": "Whether to show the chart title.",
"title": "Showtitle",
"type": "boolean"
},
"showTooltip": {
"default": false,
"description": "Whether to show the chart tooltip.",
"title": "Showtooltip",
"type": "boolean"
},
"title": {
"description": "Title of the chart.",
"title": "Title",
"type": "string"
}
},
"title": "NotebookChartCellViewOptions",
"type": "object"
}
],
"description": "Chart cell view options.",
"title": "Viewoptions"
}
},
"title": "NotebookChartCellMetadata",
"type": "object"
}
],
"description": "Chart cell view options and metadata.",
"title": "Chartsettings"
},
"collapsed": {
"default": false,
"description": "Whether the cell's output is collapsed/expanded.",
"title": "Collapsed",
"type": "boolean"
},
"customLlmMetricSettings": {
"allOf": [
{
"description": "Custom LLM metric cell metadata.",
"properties": {
"metricId": {
"description": "The ID of the custom LLM metric.",
"title": "Metricid",
"type": "string"
},
"metricName": {
"description": "The name of the custom LLM metric.",
"title": "Metricname",
"type": "string"
},
"playgroundId": {