curl --request POST \
--url https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment \
--header 'Content-Type: application/json' \
--header 'x-user-id: <api-key>' \
--data '
{
"metadata": {
"dataset": "dev 123"
},
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment"
}
'import requests
url = "https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment"
payload = {
"metadata": { "dataset": "dev 123" },
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment"
}
headers = {
"x-user-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-user-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {dataset: 'dev 123'},
name: 'Test Experiment',
project_uuid: '...',
run_name: 'test-experiment'
})
};
fetch('https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment', 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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment",
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([
'metadata' => [
'dataset' => 'dev 123'
],
'name' => 'Test Experiment',
'project_uuid' => '...',
'run_name' => 'test-experiment'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <api-key>"
],
]);
$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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment"
payload := strings.NewReader("{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-id", "<api-key>")
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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment")
.header("x-user-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-05-30 13:48:34",
"metadata": {
"dataset": "dev 123"
},
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment",
"uuid": "..."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create Experiment
Create an experiment and get the associated experiment uuid.
curl --request POST \
--url https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment \
--header 'Content-Type: application/json' \
--header 'x-user-id: <api-key>' \
--data '
{
"metadata": {
"dataset": "dev 123"
},
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment"
}
'import requests
url = "https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment"
payload = {
"metadata": { "dataset": "dev 123" },
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment"
}
headers = {
"x-user-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-user-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {dataset: 'dev 123'},
name: 'Test Experiment',
project_uuid: '...',
run_name: 'test-experiment'
})
};
fetch('https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment', 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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment",
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([
'metadata' => [
'dataset' => 'dev 123'
],
'name' => 'Test Experiment',
'project_uuid' => '...',
'run_name' => 'test-experiment'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <api-key>"
],
]);
$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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment"
payload := strings.NewReader("{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-id", "<api-key>")
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://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment")
.header("x-user-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"dataset\": \"dev 123\"\n },\n \"name\": \"Test Experiment\",\n \"project_uuid\": \"...\",\n \"run_name\": \"test-experiment\"\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-05-30 13:48:34",
"metadata": {
"dataset": "dev 123"
},
"name": "Test Experiment",
"project_uuid": "...",
"run_name": "test-experiment",
"uuid": "..."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
Name of the experiment
UUID of the project associated with this experiment
Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.
If experiment should be public
Any additional key-value pairs which provide context or are useful for filtering.
Show child attributes
Show child attributes
Response
Successful Response
Name of the experiment
UUID of the project associated with this experiment
UUID of the created experiment
Timestamp the experiment was created
Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.
If experiment should be public
Any additional key-value pairs which provide context or are useful for filtering.
Show child attributes
Show child attributes
Was this page helpful?

