Skip to main content
IBM Quantum Platform
Qiskit Transpiler Service is only available for IBM Quantum Premium Plan members.

AI Pauli Network methods

Get available backends

Gets the list of backends the user can work with

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

GET
/pauli_network/backends
curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/backends \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

Responses

[
  "example"
]

Synthesize Pauli Network

Returns a task ID; use the '/pauli_network/synthesize/{taskId}' endpoint to get the result.

Query Parameters

Name, TypeDescription
backend
string

The name of the backend. Refer to /guides/get-qpu-information.

Example: "ibm_kyoto"
topology
string
check_result
boolean

If true, the reinforcement learning (RL) model checks the result before returning a response.

Default value: false
n_steps
integer

The number of attempts (steps) that the RL model should perform to find the best synthesized circuit. More steps could give a better result (not guaranteed) but it will take more time.

Body Parameters (application/json)

Name, TypeDescription
qasm
string | null

The OpenQASM circuit to route. Both OpenQASM 2 and OpenQASM 3 are supported.

Example: "OPENQASM 3; include \"stdgates.inc\"; bit[2] meas; qubit[2] q; h q[0]; cx q[0], q[1]; barrier q[0], q[1]; meas[0] = measure q[0]; meas[1] = measure q[1];"
Example: "OPENQASM 3;\ninclude \"stdgates.inc\"; bit[2] meas; qubit[2] q; h q[0]; cx q[0], q[1]; barrier q[0], q[1]; meas[0] = measure q[0]; meas[1] = measure q[1];"
qpy
string | null

The QPY circuit to route. QPY circuits must be encoded in Base64.

Example: "UUlTS0lUDAECBAAAAAAAAAABZXEAEWYACAAAAAIAAAACAAAAAAAAAAIAAAACAAAAAAAAAAUAAAAAY2lyY3VpdC0xNzgtNTAxNTcAAAAAAAAAAHt9cQEAAAACAAEBcQAAAAAAAAAAAAAAAAAAAAFjAQAAAAIABAFtZWFzAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAUAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAASEdhdGVxAAAAAAAGAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAABAAAAAUNYR2F0ZXEAAAAAcQAAAAEABwAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABCYXJyaWVycQAAAABxAAAAAQAHAAAAAAAAAAEAAAABAAAAAAAAAAAAAAAAAAAAAAAAAE1lYXN1cmVxAAAAAGMAAAAAAAcAAAAAAAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAATWVhc3VyZXEAAAABYwAAAAEAAAD///////////////8AAAAAAAAAAA=="
coupling_map
integer[][] | null

A list of pairs that represents physical links between qubits. Must be specified if the query parameter backend is not set.

Example: [[0,1],[1,2],[2,3],[3,4]]

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

POST
/pauli_network/synthesize
curl -X POST \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/synthesize \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

Responses

{
  "task_id": "example"
}

Get synthesis result

Gets the result of a synthesis task. The Task ID needed for this endpoint is returned by the '/pauli_network/synthesize' POST endpoint.

Path Parameters

Name, TypeDescription
task_id
Required
string

The ID of the synthesis task.

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

GET
/pauli_network/synthesize/{task_id}
curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/synthesize/{task_id} \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

Responses

{
  "state": "example",
  "result": null
}

Get available topologies

Gets the list of available topologies for synthesis + transpiling the user can work with

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

GET
/pauli_network/topologies
curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/topologies \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

Responses

[
  "example"
]

Transpile a Pauli Network

Returns a task ID; use the '/pauli_network/transpile/{taskId}' endpoint to get the result.

Query Parameters

Name, TypeDescription
backend
Required
string

The name of the backend.

Body Parameters (application/json)

Name, TypeDescription
qasm
string[] | string | null

The OpenQASM circuit to route. Both OpenQASM 2 and OpenQASM 3 are supported.

Example: "OPENQASM 3; include \"stdgates.inc\"; bit[2] meas; qubit[2] q; h q[0]; cx q[0], q[1]; barrier q[0], q[1]; meas[0] = measure q[0]; meas[1] = measure q[1];"
Example: "OPENQASM 3;\ninclude \"stdgates.inc\"; bit[2] meas; qubit[2] q; h q[0]; cx q[0], q[1]; barrier q[0], q[1]; meas[0] = measure q[0]; meas[1] = measure q[1];"
qpy
string | null

The QPY circuit to route. QPY circuits must be encoded in Base64.

Example: "UUlTS0lUDAECBAAAAAAAAAABZXEAEWYACAAAAAIAAAACAAAAAAAAAAIAAAACAAAAAAAAAAUAAAAAY2lyY3VpdC0xNzgtNTAxNTcAAAAAAAAAAHt9cQEAAAACAAEBcQAAAAAAAAAAAAAAAAAAAAFjAQAAAAIABAFtZWFzAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAUAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAASEdhdGVxAAAAAAAGAAAAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAABAAAAAUNYR2F0ZXEAAAAAcQAAAAEABwAAAAAAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABCYXJyaWVycQAAAABxAAAAAQAHAAAAAAAAAAEAAAABAAAAAAAAAAAAAAAAAAAAAAAAAE1lYXN1cmVxAAAAAGMAAAAAAAcAAAAAAAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAATWVhc3VyZXEAAAABYwAAAAEAAAD///////////////8AAAAAAAAAAA=="
qargs
Required
integer[][] | integer[]
Example: [0,1,2,3,4]
Example: [[0,1,2,3,4]]
Example: [[0,1,2,3,4],[0,1,2,3,4]]
backend_coupling_map
integer[][] | null

A list of pairs that represents physical links between qubits. Must be specified if the query parameter backend is not set.

Example: [[1,2],[2,1]]

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

POST
/pauli_network/transpile
curl -X POST \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/transpile \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"qargs":[0,1,2,3,4]}'

Responses

{
  "task_id": "example"
}

Get transpilation result

Gets the result of a transpilation task. The Task ID needed for this endpoint is returned by the '/pauli_network/transpile' POST endpoint.

Path Parameters

Name, TypeDescription
task_id
Required
string

The ID of the transpilation task.

HTTP Response Status Codes

Status codeDescription
200Successful Response
422Validation Error

Code samples

GET
/pauli_network/transpile/{task_id}
curl -X GET \
  https://cloud-transpiler.quantum.ibm.com/pauli_network/transpile/{task_id} \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

Responses

{
  "state": "example",
  "result": null
}
Was this page helpful?
Report a bug or request content on GitHub.