Run Code In Jupyter

POST 
/run_jupyter

Run Code In Jupyter

Request

application/json

Body

required

cells string[]required

list of code blocks to run in jupyter notebook

cell_timeout Cell Timeout (number)
max run time for each of the cells
Default value: 0
total_timeout Total Timeout (number)
max run time for all the cells
Default value: 45
kernel Kernel (string)
Possible values: [python3]
Default value: python3

files

object

a dict from file path to base64 encoded file content

property name* string
fetch_files string[]
a list of file paths to fetch after code execution
Default value: []

Responses

200

Successful Response

application/json

Schema

Schema

status RunStatus (string)required

Possible values: [Success, Failed, SandboxError]

message Message (string)required

driver

object

anyOf

CommandRunResult

status CommandRunStatus (string)required

Possible values: [Finished, Error, TimeLimitExceeded]

execution_time

object

anyOf

MOD1

number

return_code

object

anyOf

MOD1

integer

stdout

object

anyOf

MOD1

string

stderr

object

anyOf

MOD1

string

cells

object[]

Array [

stdout Stdout (string)required

stderr Stderr (string)required

display object[]required

error object[]required

]

executor_pod_name

object

anyOf

MOD1

string

files

object

property name* string

Example (from schema)

{
  "status": "Success",
  "message": "string",
  "driver": {},
  "cells": [
    {
      "stdout": "string",
      "stderr": "string",
      "display": [
        {}
      ],
      "error": [
        {}
      ]
    }
  ],
  "executor_pod_name": "string",
  "files": {}
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...