{ "opencollection": "1.0.0", "info": { "name": "IonQ Cloud Platform backends Jobs API", "version": "v0.4" }, "items": [ { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "GetJobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs", "params": [ { "name": "ids", "value": "", "type": "query" }, { "name": "parent_job_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "target", "value": "simulator", "type": "query", "description": "Filter jobs by backend target. Supports single target or comma-separated list of targets." }, { "name": "session_id", "value": "", "type": "query" }, { "name": "submitter_id", "value": "", "type": "query", "description": "The id of another user within a shared project to view their submitted jobs. Ignored if not a project member." }, { "name": "limit", "value": "", "type": "query" }, { "name": "next", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "CreateJob", "type": "http" }, "http": { "method": "POST", "url": "https://api.ionq.co/v0.4/jobs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Submit a single-circuit or multi-circuit job for simulation or execution. In `ionq.multi-circuit.v1` payloads, each entry in `input.circuits` inherits the parent `input.gateset` unless the circuit sets its own `gateset`.\n" }, { "info": { "name": "DeleteJobs", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ionq.co/v0.4/jobs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "GetJob", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID", "params": [ { "name": "UUID", "value": "", "type": "path", "description": "The UUID of the job — this UUID is provided in the response on job creation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "DeleteJob", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ionq.co/v0.4/jobs/:UUID", "params": [ { "name": "UUID", "value": "", "type": "path", "description": "The UUID of the job — this UUID is provided in the response on job creation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "GetJobCost", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/cost", "params": [ { "name": "UUID", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "GetCompiledFile", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/circuits/:lang", "params": [ { "name": "UUID", "value": "", "type": "path" }, { "name": "lang", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Cancel a job", "type": "http" }, "http": { "method": "PUT", "url": "https://api.ionq.co/v0.4/jobs/:UUID/status/cancel", "params": [ { "name": "UUID", "value": "", "type": "path", "description": "The UUID of the job — this UUID is provided in the response on job creation." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Cancel the execution of many jobs at once by passing a list of jobs." }, { "info": { "name": "CancelJobs", "type": "http" }, "http": { "method": "PUT", "url": "https://api.ionq.co/v0.4/jobs/status/cancel", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "EstimateJobCost", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/estimate", "params": [ { "name": "backend", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "qubits", "value": "", "type": "query" }, { "name": "shots", "value": "", "type": "query" }, { "name": "1q_gates", "value": "", "type": "query" }, { "name": "2q_gates", "value": "", "type": "query" }, { "name": "error_mitigation", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Fetch the probability distribution for a completed job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/results/probabilities", "params": [ { "name": "UUID", "value": "", "type": "path", "description": "The UUID of the job." }, { "name": "sharpen", "value": "", "type": "query", "description": "Whether to apply sharpening to the probability distribution." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetch the probability distribution for a completed job." }, { "info": { "name": "GetVariantProbabilities", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/variants/:variantId/results/probabilities", "params": [ { "name": "UUID", "value": "", "type": "path" }, { "name": "variantId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "GetVariantHistogram", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/variants/:variantId/results/histogram", "params": [ { "name": "UUID", "value": "", "type": "path" }, { "name": "variantId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "GetVariantShots", "type": "http" }, "http": { "method": "GET", "url": "https://api.ionq.co/v0.4/jobs/:UUID/variants/:variantId/results/shots", "params": [ { "name": "UUID", "value": "", "type": "path" }, { "name": "variantId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } } ] } ], "bundled": true }