Skip to content

Quickstart

This quickstart is API-first and uses the current RQM service boundary.

Base URL: https://rqm-api.onrender.com

:material-book-open-variant: Swagger UI :material-api: API Overview

1) Fetch a valid example circuit

curl "https://rqm-api.onrender.com/v1/circuits/example?name=optimizable" > circuit.json

The current public circuit boundary is rqm-circuits schema 0.2.

2) Validate and analyze

curl -X POST https://rqm-api.onrender.com/v1/circuits/validate   -H "Content-Type: application/json"   -d @circuit.json

curl -X POST https://rqm-api.onrender.com/v1/circuits/analyze   -H "Content-Type: application/json"   -d @circuit.json

3) Optimize through the internal optimization engine

curl -X POST https://rqm-api.onrender.com/v1/circuits/optimize   -H "Content-Type: application/json"   -d @circuit.json

Optimization runs through the internal optimization engine and returns optimized payloads plus report metadata.

4) Inspect execution readiness, then route

curl https://rqm-api.onrender.com/v1/execute/capabilities

Then choose an execution route:

  • POST /v1/execute/qiskit
  • POST /v1/execute/braket

Next steps