Skip to main content
POST
/
jobs
Submit Local Job
curl --request POST \
  --url 'https://api.example.com/jobs?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_id": "<string>",
  "hash": "",
  "circuit_hash": "",
  "results": "",
  "device_id": "",
  "shots": "",
  "name": "",
  "status": "",
  "job_type": "",
  "metrics": {}
}
'
{
  "id": "<string>",
  "user_id": 123,
  "experiment_id": "<string>",
  "creation_date": "2023-11-07T05:31:56Z",
  "hash": "<string>",
  "backend_name": "<string>",
  "name": "<string>",
  "description": "<string>",
  "device_id": "Haiqu OS",
  "run_date": "2023-11-07T05:31:56Z",
  "finish_date": "2023-11-07T05:31:56Z",
  "logs": "<string>",
  "quality": 123,
  "info": {},
  "time": 123,
  "parameters": {},
  "circuit_id": "",
  "results": "",
  "shot_local": "",
  "metrics": {}
}

Authorizations

​
HAIQU_API_KEY
string
query
required

Body

application/json

Job submit data model for user-owned, local job/results.

  • User local Qiskit job/results, haiqu.log(job|results)
  • Data loading job
  • Execution job
​
experiment_id
string
required
​
hash
string | null
default:""
​
circuit_hash
string | null
default:""
​
results
string | null
default:""
​
device_id
string | null
default:""
​
shots
string | null
default:""
​
name
string | null
default:""
​
status
string
default:""
​
job_type
string
default:""
​
metrics
Metrics · object

Response

Successful Response

Local user-run Job (regular Qiskit job). Flow: * user run normal Qiskit job * they use haiqu.log(<job|result>) to send it to Haiqu cloud for analysis.

Qiskit and IBM runtime has several types of jobs and types of results. We do our best to analyze them all.

​
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
​
creation_date
string<date-time>
required
​
hash
string
required
​
backend_name
string
required
​
name
string | null
​
description
string | null
​
device_id
string | null
default:Haiqu OS
​
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
​
circuit_id
string | null
default:""
​
results
string | null
default:""
​
shot_local
string | null
default:""
​
metrics
Metrics · object