Init Experiment
curl --request POST \
--url 'https://api.example.com/experiments/init?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "",
"tags": "",
"metrics": {}
}
'import requests
url = "https://api.example.com/experiments/init?HAIQU_API_KEY="
payload = {
"name": "<string>",
"description": "",
"tags": "",
"metrics": {}
}
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({name: '<string>', description: '', tags: '', metrics: {}})
};
fetch('https://api.example.com/experiments/init?HAIQU_API_KEY=', 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/experiments/init?HAIQU_API_KEY=",
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([
'name' => '<string>',
'description' => '',
'tags' => '',
'metrics' => [
]
]),
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/experiments/init?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\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/experiments/init?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/experiments/init?HAIQU_API_KEY=")
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 \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"user_id": 123,
"user": {
"email": "<string>",
"username": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"api_access_key": "<string>"
},
"tags": "",
"circuits_count": 0,
"jobs_count": 0,
"last_action_date": "2023-11-07T05:31:56Z",
"metrics": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Init Experiment
Initialize experiment endpoint.
Args: user (User): User authenticated with api key. data (ExperimentSubmitModel): New experiment data.
Returns: ExperimentModel: Information about the experiment.
POST
/
experiments
/
init
Init Experiment
curl --request POST \
--url 'https://api.example.com/experiments/init?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "",
"tags": "",
"metrics": {}
}
'import requests
url = "https://api.example.com/experiments/init?HAIQU_API_KEY="
payload = {
"name": "<string>",
"description": "",
"tags": "",
"metrics": {}
}
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({name: '<string>', description: '', tags: '', metrics: {}})
};
fetch('https://api.example.com/experiments/init?HAIQU_API_KEY=', 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/experiments/init?HAIQU_API_KEY=",
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([
'name' => '<string>',
'description' => '',
'tags' => '',
'metrics' => [
]
]),
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/experiments/init?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\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/experiments/init?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/experiments/init?HAIQU_API_KEY=")
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 \"name\": \"<string>\",\n \"description\": \"\",\n \"tags\": \"\",\n \"metrics\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"user_id": 123,
"user": {
"email": "<string>",
"username": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"api_access_key": "<string>"
},
"tags": "",
"circuits_count": 0,
"jobs_count": 0,
"last_action_date": "2023-11-07T05:31:56Z",
"metrics": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Response
Successful Response
Experiment model.
Haiqu experiment is a parent/organizer entity for circuits and jobs.
User model.
MVP: Haiqu user is created by Haiqu team, auth with username/password. V2: Haiqu API user is OAuth authenticated user from IBM, Google, etc.
Show child attributes
Show child attributes