Skip to main content
POST
/
run
Run
curl --request POST \
  --url 'https://api.example.com/run?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_id": "<string>",
  "circuit_ids": [],
  "parameters": [
    "<unknown>"
  ],
  "shots": 1024,
  "observables": [
    [
      [
        [
          "<string>"
        ],
        [
          123
        ]
      ]
    ]
  ],
  "device_id": "",
  "options": {},
  "use_mitigation": false,
  "name": "",
  "description": "",
  "dry_run": false,
  "run_type": "Run"
}
'
{
  "id": "<string>",
  "user_id": 123,
  "experiment_id": "<string>",
  "status": "Submitted",
  "job_type": "User local job",
  "device_id": "<string>",
  "creation_date": "2023-11-07T05:31:56Z",
  "circuit_ids": [
    "<unknown>"
  ],
  "shots": 123,
  "options": {},
  "use_mitigation": true,
  "dry_run": true,
  "run_type": "Run",
  "name": "<string>",
  "description": "<string>",
  "run_date": "2023-11-07T05:31:56Z",
  "finish_date": "2023-11-07T05:31:56Z",
  "logs": "<string>",
  "quality": 123,
  "info": {},
  "time": 123,
  "parameters": [
    "<unknown>"
  ],
  "observables": [
    [
      [
        [
          "<string>"
        ],
        [
          123
        ]
      ]
    ]
  ],
  "quantum_results": [
    "<unknown>"
  ],
  "estimated_qpu_cost": {}
}

Authorizations

​
HAIQU_API_KEY
string
query
required

Body

application/json

Run submit payload data model.

​
experiment_id
string
required
​
circuit_ids
any[] | null
​
parameters
any[] | null
​
shots
integer
default:1024

Number of measurement shots (must be >= 1)

Required range: x >= 1
​
observables
tuple[][] | null
​
device_id
string | null
default:""
​
options
Options · object
​
use_mitigation
boolean | null
default:false
​
name
string | null
default:""
​
description
string | null
default:""
​
dry_run
boolean | null
default:false
​
run_type
string | null
default:Run

Response

Successful Response

Run Job (running on Haiqu backend).

It got access to the API client since it require to wait for the result: Property self._client: api_client.ApiClient is assigned by API client object.

​
id
string
required
​
user_id
integer
required
​
experiment_id
string
required
​
status
enum<string>
required

Class for job status.

Available options:
Submitted,
Initializing,
Queued,
Validating,
Running,
Cancelled,
Done,
Error
​
job_type
enum<string>
required

Class for job types.

Available options:
User local job,
Analytics,
Device specific analytics,
Data Loading,
Run,
State Compression,
Transpilation,
Variational,
Pretraining,
SKQD
​
device_id
string
required
​
creation_date
string<date-time>
required
​
circuit_ids
any[]
required
​
shots
integer
required
​
options
Options · object
required
​
use_mitigation
boolean | null
required
​
dry_run
boolean
required
​
run_type
enum<string>
required

Class for run_type.

Available options:
Run,
StatevectorRun
​
name
string | null
​
description
string | null
​
run_date
string<date-time> | null
​
finish_date
string<date-time> | null
​
logs
string | null
​
quality
number | null
​
info
Info · object
​
time
number | null
​
parameters
any[] | null
​
observables
tuple[][] | null
​
quantum_results
any[] | null
​
estimated_qpu_cost
Estimated Qpu Cost · object