curl --request GET \
--url https://api.example.com/api/notebooks/{s3_key}/metadata \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/notebooks/{s3_key}/metadata"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/notebooks/{s3_key}/metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/notebooks/{s3_key}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/notebooks/{s3_key}/metadata"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/notebooks/{s3_key}/metadata")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/notebooks/{s3_key}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"s3_key": "<string>",
"owner": "<string>",
"size_bytes": 123,
"last_modified": "2023-11-07T05:31:56Z",
"config": {
"name": "<string>",
"compute": "<string>",
"approval_required": false,
"schedule": "<string>"
},
"tasks": [
{
"name": "<string>",
"cell_indices": [
123
]
}
],
"inputs": [
{
"source": "spark.read.table",
"cell_index": 123,
"table": "<string>",
"format": "<string>"
}
],
"outputs": [
{
"kind": "spark_write",
"cell_index": 123,
"table": "<string>",
"mlflow_experiment": "<string>"
}
],
"framework": "<string>",
"warnings": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}Get parsed metadata for a notebook
Return parsed structure, detected I/O, and inferred config for one notebook.
curl --request GET \
--url https://api.example.com/api/notebooks/{s3_key}/metadata \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/notebooks/{s3_key}/metadata"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/notebooks/{s3_key}/metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/notebooks/{s3_key}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/notebooks/{s3_key}/metadata"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/notebooks/{s3_key}/metadata")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/notebooks/{s3_key}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"s3_key": "<string>",
"owner": "<string>",
"size_bytes": 123,
"last_modified": "2023-11-07T05:31:56Z",
"config": {
"name": "<string>",
"compute": "<string>",
"approval_required": false,
"schedule": "<string>"
},
"tasks": [
{
"name": "<string>",
"cell_indices": [
123
]
}
],
"inputs": [
{
"source": "spark.read.table",
"cell_index": 123,
"table": "<string>",
"format": "<string>"
}
],
"outputs": [
{
"kind": "spark_write",
"cell_index": 123,
"table": "<string>",
"mlflow_experiment": "<string>"
}
],
"framework": "<string>",
"warnings": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Metadata returned successfully.
Parsed notebook structure, detected I/O, and inferred pipeline config.
Object key under the notebooks bucket.
Owner username extracted from the S3 path prefix.
Size of the notebook in bytes.
S3 LastModified timestamp.
Config parsed from the nx1:config cell. Defaults if absent.
Show child attributes
Show child attributes
Tasks detected from nx1:task:* tags. Empty list means single-task pipeline.
Show child attributes
Show child attributes
Detected inputs.
Show child attributes
Show child attributes
Detected outputs.
Show child attributes
Show child attributes
Detected primary framework: spark | pandas | pytorch | sklearn | ... (None if not detected).
Static-analysis gaps or unresolved patterns to surface to the user.
Was this page helpful?

