START NOW
Job GroupsCreate Job Group
Job Groups

Create Job Group

Create a batch group. Groups start OPEN and accept child jobs until closed, cancelled, or their maxTTL elapses.

POST/jobs/group

Authorizations

X-API-KEYstringheaderrequired

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.

Body

application/json
namestring
tagsobject
metadataobject
maxTTLintegerdefault: 3600

Group TTL in seconds (1-86400). After it elapses an OPEN group is lazily auto-closed.

Response

201Group created.
successbooleanrequired
dataobjectrequired
422Validation error.
Create a job group
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());
{
  "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>"
  }
}