Skip to main content
POST
/
api
/
v2
/
external
/
execution
/
streaming
/
start
Start Python execution
curl --request POST \
  --url https://api.example.com/api/v2/external/execution/streaming/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "nbcode": 0,
  "timeout": 60,
  "requirements_content": "<string>",
  "prior_imports": [
    "<string>"
  ],
  "kernel_state": "<string>",
  "import_files": "<string>",
  "file_name": "<string>",
  "execution_type": "gpu.l40s",
  "user_callback_urls": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/api/v2/external/execution/streaming/start"

payload = {
    "code": "<string>",
    "nbcode": 0,
    "timeout": 60,
    "requirements_content": "<string>",
    "prior_imports": ["<string>"],
    "kernel_state": "<string>",
    "import_files": "<string>",
    "file_name": "<string>",
    "execution_type": "gpu.l40s",
    "user_callback_urls": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    nbcode: 0,
    timeout: 60,
    requirements_content: '<string>',
    prior_imports: ['<string>'],
    kernel_state: '<string>',
    import_files: '<string>',
    file_name: '<string>',
    execution_type: 'gpu.l40s',
    user_callback_urls: ['<string>']
  })
};

fetch('https://api.example.com/api/v2/external/execution/streaming/start', 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/v2/external/execution/streaming/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'nbcode' => 0,
    'timeout' => 60,
    'requirements_content' => '<string>',
    'prior_imports' => [
        '<string>'
    ],
    'kernel_state' => '<string>',
    'import_files' => '<string>',
    'file_name' => '<string>',
    'execution_type' => 'gpu.l40s',
    'user_callback_urls' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v2/external/execution/streaming/start"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"nbcode\": 0,\n  \"timeout\": 60,\n  \"requirements_content\": \"<string>\",\n  \"prior_imports\": [\n    \"<string>\"\n  ],\n  \"kernel_state\": \"<string>\",\n  \"import_files\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"execution_type\": \"gpu.l40s\",\n  \"user_callback_urls\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/external/execution/streaming/start")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"nbcode\": 0,\n  \"timeout\": 60,\n  \"requirements_content\": \"<string>\",\n  \"prior_imports\": [\n    \"<string>\"\n  ],\n  \"kernel_state\": \"<string>\",\n  \"import_files\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"execution_type\": \"gpu.l40s\",\n  \"user_callback_urls\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/external/execution/streaming/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"nbcode\": 0,\n  \"timeout\": 60,\n  \"requirements_content\": \"<string>\",\n  \"prior_imports\": [\n    \"<string>\"\n  ],\n  \"kernel_state\": \"<string>\",\n  \"import_files\": \"<string>\",\n  \"file_name\": \"<string>\",\n  \"execution_type\": \"gpu.l40s\",\n  \"user_callback_urls\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "execution_id": "<string>",
  "status": "<string>",
  "streaming_url": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request model for streaming code execution

code
string
required
nbcode
integer
default:0
timeout
integer
default:60
Required range: 1 <= x <= 600
requirements_content
string | null
prior_imports
string[] | null
kernel_state
string | null
import_files
string | null
file_name
string | null
execution_type
string
default:gpu.l40s
Pattern: ^[a-zA-Z0-9_.]+$
user_callback_urls
string[] | null

URLs to call with job completion info

Response

Successful Response

Response model with direct streaming URL

execution_id
string
required
status
string
required
streaming_url
string
required