Job Groups
Create Job Group
Create a batch group. Groups start OPEN and accept child jobs until closed, cancelled, or their maxTTL elapses.
Authorizations
X-API-KEYstringheaderrequiredAuthenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.
Body
application/jsonnamestringtagsobjectmetadataobjectmaxTTLintegerdefault: 3600Group TTL in seconds (1-86400). After it elapses an OPEN group is lazily auto-closed.
Response
201Group created.
successbooleanrequireddataobjectrequired422Validation error.
curl --request POST \
--url https://api-v2.qbraid.com/api/v1/jobs/group \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}'import requests
url = "https://api-v2.qbraid.com/api/v1/jobs/group"
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
payload = {
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api-v2.qbraid.com/api/v1/jobs/group";
const options = {
method: "POST",
headers: {"X-API-KEY":"<api-key>","Content-Type":"application/json"},
body: JSON.stringify({
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}),
};
const response = await fetch(url, options);
console.log(await response.json());<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs/group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => '{
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}',
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>",
"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"
"io"
"net/http"
"strings"
)
func main() {
url := "https://api-v2.qbraid.com/api/v1/jobs/group"
payload := strings.NewReader(`{
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}`)
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-v2.qbraid.com/api/v1/jobs/group"))
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"<string>\",\n \"tags\": {},\n \"metadata\": {},\n \"maxTTL\": 3600\n}"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require 'uri'
require 'net/http'
url = URI("https://api-v2.qbraid.com/api/v1/jobs/group")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = <<~JSON
{
"name": "<string>",
"tags": {},
"metadata": {},
"maxTTL": 3600
}
JSON
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "<string>",
"groupJobQrn": "group:a1b2-664f0c1e2a3b4c5d6e7f8090",
"name": "<string>",
"status": "OPEN",
"organizationUserId": "<string>",
"jobCount": 123,
"completedCount": 123,
"failedCount": 123,
"cancelledCount": 123,
"totalEstimatedCost": 123,
"totalCost": 123,
"maxTTL": 123,
"timeStamps": {
"createdAt": "2024-01-01T00:00:00Z",
"endedAt": "2024-01-01T00:00:00Z",
"executionDuration": 123
},
"tags": {},
"metadata": {}
}
}{
"success": false,
"message": "<string>",
"error": {
"message": "<string>",
"code": "<string>"
}
}POST
Create a job group
Create a job group
Response
Fill in the request and press Send to see the live response.Was this page helpful?
Thanks for your feedback.

