Skip to main content
POST
/
flow
Flow
curl --request POST \
  --url 'https://api.example.com/flow?HAIQU_API_KEY=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment_id": "<string>",
  "program": {
    "layers": [
      {
        "type": "input"
      }
    ],
    "schema_version": 1
  },
  "circuit_ids": [
    "<string>"
  ],
  "name": "",
  "description": "",
  "shots": 1000,
  "parameters": [
    "<unknown>"
  ],
  "observables": [
    [
      [
        [
          "<string>"
        ],
        [
          123
        ]
      ]
    ]
  ],
  "device_credentials": {},
  "dry_run": false
}
'
{
  "id": "<string>",
  "user_id": 123,
  "experiment_id": "<string>",
  "creation_date": "2023-11-07T05:31:56Z",
  "program": {
    "layers": [
      {
        "type": "input"
      }
    ],
    "schema_version": 1
  },
  "input_circuit_ids": [
    "<string>"
  ],
  "shots": 123,
  "dry_run": true,
  "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": [
    "<unknown>"
  ],
  "observables": [
    [
      [
        [
          "<string>"
        ],
        [
          123
        ]
      ]
    ]
  ],
  "quantum_results": [
    "<unknown>"
  ],
  "estimated_qpu_cost": {}
}

Authorizations

HAIQU_API_KEY
string
query
required

Body

application/json

Hybrid submit payload data model.

experiment_id
string
required
program
HybridProgram · object
required
circuit_ids
string[]
required
Minimum array length: 1
name
string | null
default:""
description
string | null
default:""
shots
integer
default:1000
Required range: x >= 1
parameters
any[] | null
observables
tuple[][] | null
device_credentials
Device Credentials · object
dry_run
boolean
default:false

Response

Successful Response

Hybrid Job (running on Haiqu backend).

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,
Hybrid,
Run,
State Compression,
Transpilation,
Variational,
Pretraining,
SKQD
creation_date
string<date-time>
required
program
HybridProgram · object
required
input_circuit_ids
string[]
required
shots
integer
required
dry_run
boolean
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
any[] | null
observables
tuple[][] | null
quantum_results
any[] | null
estimated_qpu_cost
Estimated Qpu Cost · object