-
-
Save jasongrout/67f2c5535f5542ab2ec3 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <html lang="en"> | |
| <head> | |
| <meta charset="utf-8" /> | |
| <title>API Reference</title> | |
| </head> | |
| <body> | |
| <h1>Jupyter Notebook API</h1> | |
| <div class="app-desc">Notebook API for </div> | |
| <div class="app-desc">More information: <a href="jupyter.org">jupyter.org</a></div> | |
| <div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div> | |
| <div class="app-desc">Version: 4</div> | |
| <div class="license-info">Apache 2.0</div> | |
| <div class="license-url">http://www.apache.org/licenses/LICENSE-2.0.html</div> | |
| <h2>Methods</h2> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /kernels</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsGet</span> List the JSON data for all kernels that are currently running</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#array">array[Kernel]</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>[ { | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| } ]</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /kernels</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsPost</span> Start a kernel and return the uuid</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| <div class="param">name (optional)</div> | |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — Kernel spec name (defaults to default kernel spec for server) </div> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#"></a></div> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /kernels/{kernel}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsKernelGet</span> Get kernel information</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Kernel</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /kernels/{kernel}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsKernelDelete</span> Kill a kernel and delete the kernel id</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#"></a></div> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /kernels/{kernel}/interrupt</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsKernelInterruptPost</span> Interrupt a kernel</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#"></a></div> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /kernels/{kernel}/restart</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernels</span></div> | |
| <div class="method-summary"><span class="nickname">kernelsKernelRestartPost</span> Restart a kernel</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Kernel</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /kernelspecs</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernelspecs</span></div> | |
| <div class="method-summary"><span class="nickname">kernelspecsGet</span> List kernel specs</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Object</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>"{}"</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /kernelspecs/{kernel}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernelspecs</span></div> | |
| <div class="method-summary"><span class="nickname">kernelspecsKernelGet</span> Kernel information</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">KernelSpec</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "name" : "aeiou", | |
| "resources" : "{}", | |
| "spec" : { | |
| "codemirror_mode" : "aeiou", | |
| "help_links" : [ "{}" ], | |
| "language" : "aeiou", | |
| "display_name" : "aeiou", | |
| "env" : { | |
| "key" : "aeiou" | |
| }, | |
| "argv" : [ "aeiou" ] | |
| } | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /kernelspecs/{kernel}/{filename}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Kernelspecs</span></div> | |
| <div class="method-summary"><span class="nickname">kernelspecsKernelFilenameGet</span> Retrieve a file from the kernel directory</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| <div class="param">kernel (required)</div> | |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — Kernel uuid </div> | |
| <div class="param">filename (required)</div> | |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — filename </div> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#"></a></div> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /sessions</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Sessions</span></div> | |
| <div class="method-summary"><span class="nickname">sessionsGet</span> List available sessions</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#array">array[Session]</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>[ { | |
| "kernel" : { | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }, | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", | |
| "notebook" : "{}" | |
| } ]</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="post"><code class="huge"><span>post</span>: /sessions</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Sessions</span></div> | |
| <div class="method-summary"><span class="nickname">sessionsPost</span> Create a new session, or return an existing session if a session for the notebook path already exists</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| <div class="param">session (optional)</div> | |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — </div> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Session</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "kernel" : { | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }, | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", | |
| "notebook" : "{}" | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="get"><code class="huge"><span>get</span>: /sessions/{session}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Sessions</span></div> | |
| <div class="method-summary"><span class="nickname">sessionsSessionGet</span> Get session</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Session</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "kernel" : { | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }, | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", | |
| "notebook" : "{}" | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="delete"><code class="huge"><span>delete</span>: /sessions/{session}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Sessions</span></div> | |
| <div class="method-summary"><span class="nickname">sessionsSessionDelete</span> Delete a session</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#"></a></div> | |
| </div> <!-- method --> | |
| <hr> | |
| <div class="method"> | |
| <div class="method-path"><pre class="patch"><code class="huge"><span>patch</span>: /sessions/{session}</code></pre></div> | |
| <div class="method-tags"> <span class="method-tag">Sessions</span></div> | |
| <div class="method-summary"><span class="nickname">sessionsSessionPatch</span> This can be used to rename the notebook, or move it to a new directory.</div> | |
| <div class="method-notes"></div> | |
| <h3 class="field-label">Parameters</h3> | |
| <div class="field-items"> | |
| <div class="param">model (required)</div> | |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — </div> | |
| </div> <!-- field-items --> | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Session</a></div> | |
| <h3 class="field-label">Example data</h3> | |
| <div class="example-data-content-type">Content-Type: application/json</div> | |
| <pre class="example"><code>{ | |
| "kernel" : { | |
| "name" : "aeiou", | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" | |
| }, | |
| "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", | |
| "notebook" : "{}" | |
| }</code></pre> | |
| </div> <!-- method --> | |
| <hr> | |
| <h2>Models</h2> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="KernelSpec">KernelSpec</a></h3> | |
| <div class="field-items"> | |
| <div class="param">name </div><div class="param-desc"><span class="param-type">String</span> Unique name for kernel</div> | |
| <div class="param">spec </div><div class="param-desc"><span class="param-type">KernelSpecFile</span> Kernel spec json file</div> | |
| <div class="param">resources </div><div class="param-desc"><span class="param-type">Object</span> </div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="KernelSpecFile">KernelSpecFile</a></h3> | |
| <div class="field-items"> | |
| <div class="param">language </div><div class="param-desc"><span class="param-type">String</span> The programming language which this kernel runs. This will be stored in notebook metadata.</div> | |
| <div class="param">argv </div><div class="param-desc"><span class="param-type">array[String]</span> A list of command line arguments used to start the kernel. The text `{connection_file}` in any argument will be replaced with the path to the connection file.</div> | |
| <div class="param">display_name </div><div class="param-desc"><span class="param-type">String</span> The kernel's name as it should be displayed in the UI. Unlike the kernel name used in the API, this can contain arbitrary unicode characters.</div> | |
| <div class="param">codemirror_mode </div><div class="param-desc"><span class="param-type">String</span> Codemirror mode. Can be a string *or* an valid Codemirror mode object. This defaults to the string from the `language` property.</div> | |
| <div class="param">env </div><div class="param-desc"><span class="param-type">map[String, String]</span> A dictionary of environment variables to set for the kernel. These will be added to the current environment variables.</div> | |
| <div class="param">help_links </div><div class="param-desc"><span class="param-type">array[Object]</span> Help items to be displayed in the help menu in the notebook UI.</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Kernel">Kernel</a></h3> | |
| <div class="field-items"> | |
| <div class="param">id </div><div class="param-desc"><span class="param-type">String</span> uuid of kernel</div> | |
| <div class="param">name </div><div class="param-desc"><span class="param-type">String</span> kernel spec name</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Session">Session</a></h3> | |
| <div class="field-items"> | |
| <div class="param">id </div><div class="param-desc"><span class="param-type">String</span> </div> | |
| <div class="param">notebook </div><div class="param-desc"><span class="param-type">Object</span> </div> | |
| <div class="param">kernel </div><div class="param-desc"><span class="param-type">Kernel</span> </div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <style> | |
| body { | |
| font-family: Trebuchet MS, sans-serif; | |
| font-size: 15px; | |
| color: #444; | |
| margin-right: 24px; | |
| } | |
| h1 { | |
| font-size: 25px; | |
| } | |
| h2 { | |
| font-size: 20px; | |
| } | |
| h3 { | |
| font-size: 16px; | |
| font-weight: bold; | |
| } | |
| hr { | |
| height: 1px; | |
| border: 0; | |
| color: #ddd; | |
| background-color: #ddd; | |
| display: none; | |
| } | |
| .app-desc { | |
| clear: both; | |
| margin-left: 20px; | |
| } | |
| .param-name { | |
| width: 100%; | |
| } | |
| .license-info { | |
| margin-left: 20px; | |
| } | |
| .license-url { | |
| margin-left: 20px; | |
| } | |
| .model { | |
| margin: 0 0 0px 20px; | |
| } | |
| .method { | |
| margin-left: 20px; | |
| } | |
| .method-notes { | |
| margin: 10px 0 20px 0; | |
| font-size: 90%; | |
| color: #555; | |
| } | |
| pre { | |
| padding: 10px; | |
| margin-bottom: 2px; | |
| } | |
| pre.get { | |
| background-color: #0f6ab4; | |
| } | |
| pre.post { | |
| background-color: #10a54a; | |
| } | |
| pre.put { | |
| background-color: #c5862b; | |
| } | |
| pre.delete { | |
| background-color: #a41e22; | |
| } | |
| .huge { | |
| color: #fff; | |
| } | |
| pre.example { | |
| background-color: #f3f3f3; | |
| padding: 10px; | |
| border: 1px solid #ddd; | |
| } | |
| code { | |
| white-space: pre; | |
| } | |
| .nickname { | |
| font-weight: bold; | |
| } | |
| .method-path { | |
| font-size: 1.5em; | |
| background-color: #0f6ab4; | |
| } | |
| .parameter { | |
| width: 500px; | |
| } | |
| .param { | |
| width: 500px; | |
| padding: 10px 0 0 20px; | |
| font-weight: bold; | |
| } | |
| .param-desc { | |
| width: 700px; | |
| padding: 0 0 0 20px; | |
| color: #777; | |
| } | |
| .param-type { | |
| font-style: italic; | |
| } | |
| .field-label { | |
| padding: 0; | |
| margin: 0; | |
| clear: both; | |
| } | |
| .field-items { | |
| padding: 0 0 15px 0; | |
| margin-bottom: 15px; | |
| } | |
| .return-type { | |
| clear: both; | |
| padding-bottom: 10px; | |
| } | |
| .param-header { | |
| font-weight: bold; | |
| } | |
| .method-tags { | |
| text-align: right; | |
| } | |
| .method-tag { | |
| background: none repeat scroll 0% 0% #24A600; | |
| border-radius: 3px; | |
| padding: 2px 10px; | |
| margin: 2px; | |
| color: #FFF; | |
| display: inline-block; | |
| text-decoration: none; | |
| } | |
| </style> | |
| </body> | |
| </html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment