REST API
- POST /compile
Post Compile
Enqueue a
BackgroundTasksto process theCompileRequest.- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /enrich
Post Enrich
Enqueue a
BackgroundTasksto enrich all nodes in theCompileRequest.- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /insert
Post Insert
Insert enrichments via
InsertRequest.- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request
500 Internal Server Error – Internal Server Error
422 Unprocessable Entity – Validation Error
- GET /status/{uuid}
Get Status
Fetch status of a compile request.
- Raises HTTPException:
(Status 404) If no compile request with uuid is found
- Parameters:
uuid (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /result/{uuid}
Get Result
Fetch result of a compile request.
- Raises HTTPException:
(Status 404) If no compile request with uuid is found
- Parameters:
uuid (string)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /debug/compile
Post Debug Compile
Compiles the request to an openqasm3 program in one request. No redirects and no polling of different endpoints needed.
This endpoint should only be used for debugging purposes.
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request
500 Internal Server Error – Internal Server Error
422 Unprocessable Entity – Validation Error
- POST /debug/enrich
Post Debug Enrich
Enriches all nodes in the compile request in one request. No redirects and no polling of different endpoints needed.
This endpoint should only be used for debugging purposes.
- Status Codes:
200 OK – Successful Response
400 Bad Request – Bad Request
500 Internal Server Error – Internal Server Error
422 Unprocessable Entity – Validation Error