Create Job

Submit a quantum job to the specified device.

Request Body:

• program (object, required): Quantum program with format and data fields
• shots (integer, required): Number of shots to execute
• deviceQrn (string, required): Device QRN (qBraid Resource Name)
• runtimeOptions (object, optional): Runtime options
• tags (object, optional): Job tags
• name (string, optional): Job name

Headers:

• X-API-KEY (string, required): Your qBraid API key

Returns:

• Object containing the new job QRN and initial status

Raises:

• 422: Validation error if required fields are missing or invalid

POST /jobs

Create Job

cURL

curl --request POST \
  --url https://api-v2.qbraid.com/api/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "shots": 123,
  "deviceQrn": "<string>",
  "program": {
    "data": "<unknown>"
  },
  "name": "<string>",
  "tags": {},
  "runtimeOptions": {}
}
'

201

{
  "success": true,
  "data": {
    "jobQrn": "aws:aws:sim:dm1-a1b2-qjob-1234567890abcdef",
    "status": "INITIALIZING"
  }
}

201

{
  "success": true,
  "data": {
    "jobQrn": "aws:aws:sim:dm1-a1b2-qjob-1234567890abcdef",
    "status": "INITIALIZING"
  }
}

Authorizations

X-API-KEY · string · header · required

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

Schema for job submission request body

shots · integer · required

Number of shots to execute

deviceQrn · string · required

qBraid device resource name

program · Program · object · required

Schema for quantum program

Show child attributes

name · string | null

Job name

tags · Tags · object

Job tags

Show child attributes

runtimeOptions · Runtimeoptions · object

Runtime options

Response

201

application/json

Successful Response

Response schema for job creation

success · boolean · required

Whether the job was created successfully

data · object · required

Show child attributes