Recipe Preview
curl --request POST \
--url https://{host}/api/submissions/recipe-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipe": "<string>",
"digest": "<string>",
"project": "<string>",
"name": "training",
"framework_version": "",
"model": "",
"train_dataset": "",
"validation_dataset": "",
"train_split": "",
"validation_split": "",
"image": "",
"observability_url": "",
"series": "",
"nodes": 1,
"gpus_per_node": 1,
"cpus": 0,
"memory_gb": 0,
"parameters": {}
}
'import requests
url = "https://{host}/api/submissions/recipe-previews"
payload = {
"recipe": "<string>",
"digest": "<string>",
"project": "<string>",
"name": "training",
"framework_version": "",
"model": "",
"train_dataset": "",
"validation_dataset": "",
"train_split": "",
"validation_split": "",
"image": "",
"observability_url": "",
"series": "",
"nodes": 1,
"gpus_per_node": 1,
"cpus": 0,
"memory_gb": 0,
"parameters": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipe: '<string>',
digest: '<string>',
project: '<string>',
name: 'training',
framework_version: '',
model: '',
train_dataset: '',
validation_dataset: '',
train_split: '',
validation_split: '',
image: '',
observability_url: '',
series: '',
nodes: 1,
gpus_per_node: 1,
cpus: 0,
memory_gb: 0,
parameters: {}
})
};
fetch('https://{host}/api/submissions/recipe-previews', 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://{host}/api/submissions/recipe-previews",
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([
'recipe' => '<string>',
'digest' => '<string>',
'project' => '<string>',
'name' => 'training',
'framework_version' => '',
'model' => '',
'train_dataset' => '',
'validation_dataset' => '',
'train_split' => '',
'validation_split' => '',
'image' => '',
'observability_url' => '',
'series' => '',
'nodes' => 1,
'gpus_per_node' => 1,
'cpus' => 0,
'memory_gb' => 0,
'parameters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/api/submissions/recipe-previews"
payload := strings.NewReader("{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{host}/api/submissions/recipe-previews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/submissions/recipe-previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"digest": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"resolved": {},
"provenance": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Recipe Preview
POST
/
api
/
submissions
/
recipe-previews
Recipe Preview
curl --request POST \
--url https://{host}/api/submissions/recipe-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipe": "<string>",
"digest": "<string>",
"project": "<string>",
"name": "training",
"framework_version": "",
"model": "",
"train_dataset": "",
"validation_dataset": "",
"train_split": "",
"validation_split": "",
"image": "",
"observability_url": "",
"series": "",
"nodes": 1,
"gpus_per_node": 1,
"cpus": 0,
"memory_gb": 0,
"parameters": {}
}
'import requests
url = "https://{host}/api/submissions/recipe-previews"
payload = {
"recipe": "<string>",
"digest": "<string>",
"project": "<string>",
"name": "training",
"framework_version": "",
"model": "",
"train_dataset": "",
"validation_dataset": "",
"train_split": "",
"validation_split": "",
"image": "",
"observability_url": "",
"series": "",
"nodes": 1,
"gpus_per_node": 1,
"cpus": 0,
"memory_gb": 0,
"parameters": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipe: '<string>',
digest: '<string>',
project: '<string>',
name: 'training',
framework_version: '',
model: '',
train_dataset: '',
validation_dataset: '',
train_split: '',
validation_split: '',
image: '',
observability_url: '',
series: '',
nodes: 1,
gpus_per_node: 1,
cpus: 0,
memory_gb: 0,
parameters: {}
})
};
fetch('https://{host}/api/submissions/recipe-previews', 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://{host}/api/submissions/recipe-previews",
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([
'recipe' => '<string>',
'digest' => '<string>',
'project' => '<string>',
'name' => 'training',
'framework_version' => '',
'model' => '',
'train_dataset' => '',
'validation_dataset' => '',
'train_split' => '',
'validation_split' => '',
'image' => '',
'observability_url' => '',
'series' => '',
'nodes' => 1,
'gpus_per_node' => 1,
'cpus' => 0,
'memory_gb' => 0,
'parameters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{host}/api/submissions/recipe-previews"
payload := strings.NewReader("{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{host}/api/submissions/recipe-previews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/submissions/recipe-previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipe\": \"<string>\",\n \"digest\": \"<string>\",\n \"project\": \"<string>\",\n \"name\": \"training\",\n \"framework_version\": \"\",\n \"model\": \"\",\n \"train_dataset\": \"\",\n \"validation_dataset\": \"\",\n \"train_split\": \"\",\n \"validation_split\": \"\",\n \"image\": \"\",\n \"observability_url\": \"\",\n \"series\": \"\",\n \"nodes\": 1,\n \"gpus_per_node\": 1,\n \"cpus\": 0,\n \"memory_gb\": 0,\n \"parameters\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"digest": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"resolved": {},
"provenance": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Human-editable recipe inputs; the server owns the resulting JobSpec.
Required string length:
1 - 128Required string length:
1 - 128Required string length:
1 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$Required range:
1 <= x <= 1024Required range:
0 <= x <= 1024Required range:
x >= 0Required range:
x >= 0