openapi: 3.0.3 info: contact: email: support@ionq.co name: IonQ url: https://ionq.com/ description: '*Last updated: May 15, 2026* IonQ''s API for accessing the IonQ Quantum Cloud platform Please subscribe for automated updates when we perform maintenance or experience an outage. In addition, you may use the [status endpoint](#tag/status) to check the current status of our API. ## Authentication ' title: IonQ Cloud Platform API version: v0.4 servers: - url: https://api.ionq.co/v0.4 paths: /whoami: get: description: Retrieves current key associated with this session. operationId: getWhoami responses: '200': $ref: '#/components/responses/Whoami' summary: Get current key tags: - whoami x-codeSamples: - lang: curl source: "curl \"https://api.ionq.co/v0.4/whoami\" \\\n -H \"Authorization: apiKey your-api-key\"\n" /backends: get: description: This endpoint retrieves all backends. operationId: getBackends responses: '200': $ref: '#/components/responses/ListBackends' security: [] summary: Get Backends tags: - backends x-codeSamples: - lang: curl source: 'curl "https://api.ionq.co/v0.4/backends" ' /backends/{backend}: get: description: This endpoint retrieves a backend. operationId: getBackend parameters: - $ref: '#/components/parameters/backend' responses: '200': $ref: '#/components/responses/GetBackend' security: [] summary: Get a Backend tags: - backends x-codeSamples: - lang: curl source: 'curl "https://api.ionq.co/v0.4/backends/qpu.aria-1" ' /backends/{backend}/characterizations: get: description: This endpoint retrieves an array of all available backend characterizations, with pagination. operationId: getCharacterizationsForBackend parameters: - $ref: '#/components/parameters/backend' - description: Characterizations starting at this time (e.g., `start=2025-12-31`) in: query name: start schema: type: string - description: Characterizations before this time (e.g., `end=2025-12-31`) in: query name: end schema: type: string - description: How many objects to return. in: query name: limit schema: default: 10 maximum: 10 minimum: 1 type: integer - $ref: '#/components/parameters/pagination-page' responses: '200': $ref: '#/components/responses/ListCharacterizations' security: [] summary: Get All Backend Characterizations tags: - characterizations x-codeSamples: - lang: curl source: 'curl "https://api.ionq.co/v0.4/backends/qpu.aria-1/characterizations" ' /backends/{backend}/characterizations/{UUID}: get: description: This endpoint retrieves a characterization. operationId: getCharacterization parameters: - $ref: '#/components/parameters/backend' - $ref: '#/components/parameters/uuid' responses: '200': $ref: '#/components/responses/GetCharacterization' summary: Get a Characterization tags: - characterizations x-codeSamples: - lang: curl source: "curl \"https://api.ionq.co/v0.4/backends/qpu.aria-1/characterizations/aa54e783-0a9b-4f73-ad2f-63983b6aa4a8\"\ \ \\\n -H \"Authorization: apiKey your-api-key\"\n" /jobs: post: operationId: CreateJob responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/JobCreationResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobCreationPayload' description: '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`. ' x-codeSamples: - lang: curl label: Single-circuit QIS job source: "curl -X POST \"https://api.ionq.co/v0.4/jobs\" \\\n -H \"Authorization: apiKey your-api-key\" \\\n -H \"\ Content-Type: application/json\" \\\n -d '{\n \"type\" : \"ionq.circuit.v1\",\n \"name\": \"Sample circuit\"\ ,\n \"metadata\": {\n \"fizz\": \"buzz\",\n \"foo\": \"bar\"\n },\n \"shots\": 500,\n \"backend\"\ : \"qpu.forte-1\",\n \"settings\" :\n {\n \"error_mitigation\":\n {\n \"debiasing\": false\n\ \ }\n },\n \"input\": {\n \"qubits\": 2,\n \"gateset\": \"qis\",\n \"circuit\": [\n \ \ {\n \"gate\": \"h\",\n \"target\": 0\n }\n ]\n }\n }'\n" - lang: curl label: Mixed-gateset multi-circuit job source: "curl -X POST \"https://api.ionq.co/v0.4/jobs\" \\\n -H \"Authorization: apiKey your-api-key\" \\\n -H \"\ Content-Type: application/json\" \\\n -d '{\n \"type\": \"ionq.multi-circuit.v1\",\n \"backend\": \"simulator\"\ ,\n \"shots\": 500,\n \"input\": {\n \"gateset\": \"native\",\n \"qubits\": 2,\n \"circuits\"\ : [\n {\n \"name\": \"qis circuit override\",\n \"gateset\": \"qis\",\n \"circuit\"\ : [\n {\n \"gate\": \"h\",\n \"target\": 0\n },\n {\n\ \ \"gate\": \"cnot\",\n \"target\": 0,\n \"control\": 1\n }\n\ \ ]\n },\n {\n \"name\": \"native circuit from parent\",\n \"circuit\"\ : [\n {\n \"gate\": \"ms\",\n \"targets\": [0, 1],\n \"phases\"\ : [0, 0.25]\n },\n {\n \"gate\": \"gpi2\",\n \"target\": 0,\n \ \ \"phase\": 0.75\n }\n ]\n }\n ]\n }\n }'\n" get: operationId: GetJobs responses: '200': description: Successfully retrieved a list of jobs. content: application/json: schema: $ref: '#/components/schemas/GetJobsResponse' examples: Example 1: value: jobs: - id: e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524 status: completed type: ionq.circuit.v1 backend: simulator dry_run: false cost_model: quantum_compute_time submitter_id: 64b03577072d45001c85e9c4 project_id: 1333d459-cf47-4a5e-acc1-8d4eb4f7b025 parent_job_id: null session_id: null metadata: null name: null submitted_at: '2025-05-28T20:47:05.440Z' started_at: null completed_at: null predicted_execution_duration_ms: null predicted_wait_time_ms: null execution_duration_ms: null shots: 1000 noise: model: ideal failure: null settings: compilation: {} stats: qubits: 20 circuits: 1 gate_counts: 1q: 1028 2q: 110 predicted_quantum_compute_time_us: 5000 billed_quantum_compute_time_us: 5200 results: probabilities: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/results/probabilities output: {} next: null '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - in: query name: ids required: false schema: type: array items: type: string - in: query name: parent_job_id required: false schema: type: string - in: query name: status required: false schema: $ref: '#/components/schemas/JobStatus' - description: Filter jobs by backend target. Supports single target or comma-separated list of targets. in: query name: target required: false schema: type: string example: simulator - in: query name: session_id required: false schema: type: string - description: The id of another user within a shared project to view their submitted jobs. Ignored if not a project member. in: query name: submitter_id required: false schema: type: string - in: query name: limit required: false schema: format: int32 type: integer - in: query name: next required: false schema: type: string x-codeSamples: - lang: curl source: "# Get all jobs:\ncurl \"https://api.ionq.co/v0.4/jobs\" \\\n -H \"Authorization: apiKey your-api-key\"\n" delete: operationId: DeleteJobs responses: '200': description: Successfully deleted a list of jobs. content: application/json: schema: $ref: '#/components/schemas/JobsDeletedResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobsBulkOperationRequest' x-codeSamples: - lang: curl source: "curl -X DELETE \"https://api.ionq.co/v0.4/jobs\" \\\n -H \"Authorization: apiKey your-api-key\" \\\n -H\ \ \"Content-Type: application/json\" \\\n -d '{\n \"ids\": [\n \"617a1f8b-59d4-435d-aa33-695433d7155e\"\ ,\n \"2ccf2773-4c28-468e-a290-2f8554808a25\",\n \"f92df2b6-d212-4f4a-b9ea-024b58c5c3e8\"\n\ \ ]\n }'\n" /jobs/{UUID}: get: operationId: GetJob responses: '200': description: Successfully retrieved a job. content: application/json: schema: $ref: '#/components/schemas/GetJobResponse' examples: Example 1: value: id: e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524 status: completed type: ionq.circuit.v1 backend: simulator dry_run: false cost_model: quantum_compute_time submitter_id: 64b03577072d45001c85e9c4 project_id: 1333d459-cf47-4a5e-acc1-8d4eb4f7b025 parent_job_id: null child_job_ids: null session_id: null metadata: null name: null submitted_at: '2025-05-28T20:47:05.440Z' started_at: null completed_at: null predicted_execution_duration_ms: null predicted_wait_time_ms: null execution_duration_ms: null shots: 1000 noise: model: ideal failure: null settings: compilation: {} stats: qubits: 20 circuits: 1 gate_counts: 1q: 1028 2q: 110 predicted_quantum_compute_time_us: 5000 billed_quantum_compute_time_us: 5200 results: probabilities: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/results/probabilities output: compilation: {} error_mitigation: debiasing: variants: - variant_id: 069ce8f8-f437-7d75-8000-9f5f8c3d7897 qubit_map: - 4 - 12 - 7 shots: 120 results: probabilities: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/variants/069ce8f8-f437-7d75-8000-9f5f8c3d7897/results/probabilities histogram: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/variants/069ce8f8-f437-7d75-8000-9f5f8c3d7897/results/histogram shots: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/variants/069ce8f8-f437-7d75-8000-9f5f8c3d7897/results/shots '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - description: "The UUID of the job \u2014 this UUID is provided in the response on job creation." in: path name: UUID required: true schema: type: string x-codeSamples: - lang: curl source: "curl \"https://api.ionq.co/v0.4/jobs/617a1f8b-59d4-435d-aa33-695433d7155e\" \\\n -H \"Authorization: apiKey\ \ your-api-key\"\n" delete: operationId: DeleteJob responses: '200': description: Successfully deleted a job. content: application/json: schema: $ref: '#/components/schemas/JobDeletedResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - description: "The UUID of the job \u2014 this UUID is provided in the response on job creation." in: path name: UUID required: true schema: type: string x-codeSamples: - lang: curl source: "curl -X DELETE \"https://api.ionq.co/v0.4/jobs/617a1f8b-59d4-435d-aa33-695433d7155e\" \\\n -H \"Authorization:\ \ apiKey your-api-key\"\n" /jobs/{UUID}/cost: get: operationId: GetJobCost responses: '200': description: Successfully retrieved the cost of a job. content: application/json: schema: $ref: '#/components/schemas/GetJobCostResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - in: path name: UUID required: true schema: type: string x-codeSamples: - lang: curl source: "curl \"https://api.ionq.co/v0.4/jobs/0197379a-c3b8-7548-9da4-bbb7067311c1/cost\" \\\n -H \"Authorization:\ \ apiKey your-api-key\"\n" /jobs/{UUID}/circuits/{lang}: get: operationId: GetCompiledFile responses: '200': description: Successfully downloaded a compiled file. content: application/json: schema: type: string '403': description: Forbidden '404': description: Not Found '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - in: path name: UUID required: true schema: type: string - in: path name: lang required: true schema: type: string enum: - native - qasm3 /jobs/{UUID}/status/cancel: put: operationId: CancelJob responses: '200': description: Successfully canceled a job. content: application/json: schema: $ref: '#/components/schemas/JobCanceledResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co description: Cancel the execution of many jobs at once by passing a list of jobs. summary: Cancel a job security: - apiKeyAuth: [] parameters: - description: "The UUID of the job \u2014 this UUID is provided in the response on job creation." in: path name: UUID required: true schema: type: string x-codeSamples: - lang: curl source: "curl -X PUT \"https://api.ionq.co/v0.4/jobs/617a1f8b-59d4-435d-aa33-695433d7155e/status/cancel\" \\\n -H\ \ \"Authorization: apiKey your-api-key\"\n" /jobs/status/cancel: put: operationId: CancelJobs responses: '200': description: Successfully canceled a list of jobs. content: application/json: schema: $ref: '#/components/schemas/JobsCanceledResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobsBulkOperationRequest' x-codeSamples: - lang: curl source: "curl -X PUT \"https://api.ionq.co/v0.4/jobs/status/cancel\" \\\n -H \"Authorization: apiKey your-api-key\"\ \ \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ids\": [\n \"617a1f8b-59d4-435d-aa33-695433d7155e\"\ ,\n \"2ccf2773-4c28-468e-a290-2f8554808a25\",\n \"f92df2b6-d212-4f4a-b9ea-024b58c5c3e8\"\n\ \ ]\n }'\n" /jobs/estimate: get: operationId: EstimateJobCost responses: '200': description: Successfully retrieved the cost estimate of a job. content: application/json: schema: $ref: '#/components/schemas/GetJobEstimateResponse' '429': description: Too Many Requests. To get a higher rate limit, please reach out to support@ionq.co '500': description: A generic server failure, please reach out to support@ionq.co for help with this error '502': description: Bad Gateway, this can be caused by misbehaving proxies, or by service issues. These can be retried, and downtime can be found on status.ionq.co '503': description: Service Unavailable, this is indicative of service outage, please check status.ionq.co security: - apiKeyAuth: [] parameters: - in: query name: backend required: true schema: $ref: '#/components/schemas/JobBackends' - in: query name: type required: false schema: default: ionq.circuit.v1 type: string - in: query name: qubits required: false schema: default: 25 format: int32 type: integer - in: query name: shots required: false schema: default: 1000 format: int32 type: integer - in: query name: 1q_gates required: false schema: default: 0 format: int32 type: integer - in: query name: 2q_gates required: false schema: default: 0 format: int32 type: integer - in: query name: error_mitigation required: false schema: default: false type: boolean /jobs/{UUID}/results/probabilities: get: operationId: GetJobProbabilities responses: '200': description: Probability distribution keyed by decimal qubit state. content: application/json: schema: $ref: '#/components/schemas/GetResultsResponse' '404': description: Job not found or not yet completed. summary: Fetch the probability distribution for a completed job. security: - apiKeyAuth: [] parameters: - description: The UUID of the job. in: path name: UUID required: true schema: type: string - description: Whether to apply sharpening to the probability distribution. in: query name: sharpen required: false schema: type: boolean /jobs/{UUID}/variants/{variantId}/results/probabilities: get: operationId: GetVariantProbabilities responses: '200': description: Per-variant probabilities histogram content: application/json: schema: $ref: '#/components/schemas/GetVariantResultsResponse' '404': description: Not found security: - apiKeyAuth: [] parameters: - in: path name: UUID required: true schema: type: string - in: path name: variantId required: true schema: type: string /jobs/{UUID}/variants/{variantId}/results/histogram: get: operationId: GetVariantHistogram responses: '200': description: Per-variant raw histogram (counts) content: application/json: schema: $ref: '#/components/schemas/GetVariantResultsResponse' '404': description: Not found security: - apiKeyAuth: [] parameters: - in: path name: UUID required: true schema: type: string - in: path name: variantId required: true schema: type: string /jobs/{UUID}/variants/{variantId}/results/shots: get: operationId: GetVariantShots responses: '200': description: Per-variant shot-wise results content: application/json: schema: $ref: '#/components/schemas/GetVariantResultsResponse' '404': description: Not found security: - apiKeyAuth: [] parameters: - in: path name: UUID required: true schema: type: string - in: path name: variantId required: true schema: type: string /sessions: post: operationId: CreateSession responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Session' security: - apiKeyAuth: [] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSessionRequest' get: operationId: GetSessions responses: '200': description: Successfully retrieved a list of sessions. content: application/json: schema: $ref: '#/components/schemas/SessionsResponse' security: - apiKeyAuth: [] parameters: - in: query name: active required: false schema: type: boolean /sessions/{session_id}/end: post: operationId: EndSession responses: '200': description: Successfully end a session. content: application/json: schema: $ref: '#/components/schemas/Session' security: - apiKeyAuth: [] parameters: - description: "The id of the session \u2014 this id is provided in the response on session creation." in: path name: session_id required: true schema: type: string /sessions/{session_id}: get: operationId: GetSession responses: '200': description: Successfully retrieved a session. content: application/json: schema: $ref: '#/components/schemas/Session' security: - apiKeyAuth: [] parameters: - description: "The id of the session \u2014 this id is provided in the response on session creation." in: path name: session_id required: true schema: type: string /sessions/{session_id}/jobs: get: operationId: GetSessionJobs responses: '200': description: Successfully retrieved a list of jobs from a session. content: application/json: schema: $ref: '#/components/schemas/GetJobsResponse' examples: Example 1: value: jobs: - id: e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524 status: completed type: ionq.circuit.v1 backend: simulator dry_run: false cost_model: quantum_compute_time submitter_id: 64b03577072d45001c85e9c4 project_id: 1333d459-cf47-4a5e-acc1-8d4eb4f7b025 parent_job_id: null session_id: null metadata: null name: null submitted_at: '2025-05-28T20:47:05.440Z' started_at: null completed_at: null predicted_execution_duration_ms: null predicted_wait_time_ms: null execution_duration_ms: null shots: 1000 noise: model: ideal failure: null settings: compilation: {} stats: qubits: 20 circuits: 1 gate_counts: 1q: 1028 2q: 110 predicted_quantum_compute_time_us: 5000 billed_quantum_compute_time_us: 5200 results: probabilities: url: /v0.4/jobs/e1a09d90-b2ba-4ea5-9fd7-4bfc14eac524/results/probabilities output: {} next: null security: - apiKeyAuth: [] parameters: - in: path name: session_id required: true schema: type: string - in: query name: ids required: false schema: type: array items: type: string - in: query name: parent_job_id required: false schema: type: string - in: query name: status required: false schema: $ref: '#/components/schemas/JobStatus' - description: Filter jobs by backend target. Supports single target or comma-separated list of targets. in: query name: target required: false schema: type: string example: simulator - in: query name: session_id required: false schema: type: string - description: The id of another user within a shared project to view their submitted jobs. Ignored if not a project member. in: query name: submitter_id required: false schema: type: string - in: query name: limit required: false schema: format: int32 type: integer - in: query name: next required: false schema: type: string /organizations/{organization_id}/usage: get: description: Retrieves the costs of a given group type, broken down by the given date modality. operationId: get-usages parameters: - $ref: '#/components/parameters/organization_id' - description: Start date, inclusive example: '2023-07-01' in: query name: start_date required: true schema: format: date type: string - description: End date, exclusive example: '2023-08-01' in: query name: end_date required: true schema: format: date type: string - description: QPU Usage grouping in: query name: group_by required: true schema: $ref: '#/components/schemas/group_by' - description: Report modality in: query name: modality required: true schema: $ref: '#/components/schemas/modality' responses: '200': $ref: '#/components/responses/UsagesResponse' summary: Get usage costs tags: - usage x-codeSamples: - lang: curl source: "curl \"https://api.ionq.co/v0.4/organizations/com.my.org/usage?group_by=project&start_date=2025-01-01&end_date=2025-03-02&modality=weekly\"\ \ \\\n -H \"Authorization: apiKey your-api-key\"\n" components: schemas: BadRequestError: description: Error when a bad client request was received. properties: error: description: A short error type descrption. type: string message: description: A helpful error message. type: string statusCode: description: The HTTP status code for this error. type: integer validation: $ref: '#/components/schemas/RequestValidation' required: - statusCode - error - message type: object Error: description: Basic API error response. properties: error: description: A short error type descrption. type: string message: description: A helpful error message. type: string statusCode: description: The HTTP status code for this error. type: integer required: - statusCode - error - message type: object RequestValidation: description: Request validation failure details. properties: keys: description: A list of request payload keys which have bad values. items: type: string type: array source: description: Location in the request of the bad value(s). type: string type: object Whoami: description: Details of current API Key session. properties: key_id: $ref: '#/components/schemas/key-id' key_name: $ref: '#/components/schemas/key-name' project_id: $ref: '#/components/schemas/project-id' required: - key_id - key_name type: object key-id: description: UUID of a API key. example: e060759f-4348-4767-a645-8c0301265791 format: uuid type: string key-name: description: key name. example: My First Key type: string project-id: description: UUID of a project. example: 944904d6-2e30-4cfb-8bc4-04afaabcdd42 format: uuid type: string Backend: description: A backend that you can target your program to run on. properties: average_queue_time: description: Current wait time on the queue for execution. example: 1181215 format: unix-timestamp type: number backend: description: 'Specifies target hardware and generation where applies: `simulator`, `qpu.aria-1`, `qpu.aria-2`, `qpu.forte-1`, `qpu.forte-enterprise-1`, `qpu.forte-enterprise-2`, `qpu.forte-enterprise-3`' example: qpu.aria-1 type: string characterization_id: description: Current characterization ID for this backend example: 617a1f8b-59d4-435d-aa33-695433d7155e type: string degraded: description: Flag to tell if the backend is degraded or not. type: boolean kw: description: The amount of energy used by the backend in kilowatt-hours. example: 4902.81 format: double type: number last_updated: description: Last date time the backend status was updated. example: '2025-06-16T00:00:00Z' type: string location: description: The location of the backend. example: College Park, MD, USA type: string qubits: description: The number of qubits available. example: 25 minimum: 0 type: integer status: description: 'Current status of the backend: `available`, `unavailable`, `retired`.' type: string required: - backend - status - qubits - average_queue_time - last_updated type: object Characterization: description: Quantum hardware characterization data. properties: backend: description: 'The backend calibrated hardware: `simulator`, `qpu.aria-1`, `qpu.aria-2`, `qpu.forte-1`, `qpu.forte-enterprise-1`, `qpu.forte-enterprise-2`, `qpu.forte-enterprise-3`' type: string connectivity: description: An array of valid, unordered tuples of possible qubits for executing two-qubit gates (e.g., `[[0, 1], [0, 2], [1, 2]]`) example: - - 0 - 1 - - 0 - 2 - - 10 - 9 items: items: type: integer type: array type: array date: description: Date time of the measurement, in ISO format. example: '2025-06-16T00:00:00Z' type: string fidelity: description: 'Fidelity for single-qubit (`1q`) and two-qubit (`2q`) gates, and State Preparation and Measurement (`spam`) operations. Currently provides only median fidelity; additional statistical data will be added in the future. ' properties: spam: description: SPAM error correction information. properties: median: example: 0.9962 type: number stderr: description: SPAM error. example: null minimum: 0 type: integer required: - median type: object required: - spam type: object id: description: UUID of the characterization. format: uuid type: string qubits: description: The number of qubits available. example: 25 minimum: 1 type: integer timing: description: 'Time, in seconds, of various system properties: `t1` time, `t2` time, `1q` gate time, `2q` gate time, `readout` time, and qubit `reset` time.' properties: 1q: type: integer 2q: type: integer readout: description: Readout time. type: integer reset: description: qubit reset time. type: integer t1: example: 10 type: integer t2: example: 1 type: integer required: - readout - reset type: object type: object pagination-limit: default: 25 description: How many objects to return. maximum: 25 minimum: 1 type: integer pagination-next: description: ID of next batch of resources to load. format: uuid type: string pagination-page: default: 1 description: Specify the page of results to return. minimum: 1 type: integer JobStatus: type: string enum: - submitted - ready - started - canceled - failed - completed JobCreationResponse: properties: id: type: string example: 617a1f8b-59d4-435d-aa33-695433d7155e status: $ref: '#/components/schemas/JobStatus' session_id: type: string nullable: true example: null required: - id - status - session_id type: object additionalProperties: false QisGate: type: string enum: - x - y - z - rx - ry - rz - h - s - si - v - vi - t - ti - not - cnot - swap - xx - yy - zz - pauliexp Gate_QisGate: properties: gate: $ref: '#/components/schemas/QisGate' target: type: integer format: int32 targets: items: type: number format: double type: array description: The qubits that a quantum gate is applied to controls: items: type: number format: double type: array description: The qubits that determine whether the operation is applied to targets. control: type: integer format: int32 rotation: type: number format: double description: Rotation angle for rx/ry/rz gates required: - gate type: object additionalProperties: false QisCircuitInput: properties: qubits: type: integer format: int32 minimum: 1 circuit: items: $ref: '#/components/schemas/Gate_QisGate' type: array gateset: type: string enum: - qis nullable: false required: - circuit - gateset type: object additionalProperties: false NativeGate: type: string enum: - zz - ms - gpi - gpi2 - nop Gate_NativeGate: properties: gate: $ref: '#/components/schemas/NativeGate' target: type: integer format: int32 targets: items: type: number format: double type: array description: The qubits that a quantum gate is applied to controls: items: type: number format: double type: array description: The qubits that determine whether the operation is applied to targets. phase: type: number format: double description: Phase for gpi/gpi2 gates phases: items: type: number format: double type: array description: Phases for ms gate angle: type: number format: double description: Interaction angle for ms gate (in turns, default 0.25) rotation: type: number format: double description: Rotation angle for rx/ry/rz gates required: - gate type: object additionalProperties: false NativeCircuitInput: properties: qubits: type: integer format: int32 minimum: 1 circuit: items: $ref: '#/components/schemas/Gate_NativeGate' type: array gateset: type: string enum: - native nullable: false required: - circuit - gateset type: object additionalProperties: false JsonCircuitInput: anyOf: - $ref: '#/components/schemas/QisCircuitInput' title: Qis Circuit - $ref: '#/components/schemas/NativeCircuitInput' title: Native Circuit JobMetadata: properties: {} type: object additionalProperties: type: string JobBackends: type: string description: 'Available options: `simulator`, `qpu.aria-1`, `qpu.aria-2`, `qpu.forte-1`, `qpu.forte-enterprise-1`' NoiseModel: type: string enum: - ideal - harmony - harmony-1 - harmony-2 - aria-1 - aria-2 - forte-1 - forte-enterprise-1 Noise: properties: model: $ref: '#/components/schemas/NoiseModel' seed: type: integer format: int32 required: - model type: object additionalProperties: false CircuitJobCreationPayload: properties: name: type: string metadata: $ref: '#/components/schemas/JobMetadata' description: User defined metadata shots: type: integer format: int32 default: 100 minimum: 1 maximum: 1000000 backend: $ref: '#/components/schemas/JobBackends' session_id: type: string settings: properties: error_mitigation: properties: debiasing: type: boolean type: object description: To turn on debiasing, you must request at least 500 shots compilation: properties: opt: type: number format: double precision: type: string type: object type: object dry_run: type: boolean noise: $ref: '#/components/schemas/Noise' type: type: string enum: - ionq.circuit.v1 nullable: false input: $ref: '#/components/schemas/JsonCircuitInput' required: - backend - type - input type: object additionalProperties: false Registers: properties: {} type: object additionalProperties: items: type: number format: double nullable: true type: array QISCircuit: properties: name: type: string circuit: items: $ref: '#/components/schemas/Gate_QisGate' type: array description: Circuit gates. Can be either QIS gates or Native gates depending on the gateset property. qubits: type: integer format: int32 registers: $ref: '#/components/schemas/Registers' description: Registers to use in your circuit. Each register is a list of qubit indices (starting from zero). gateset: type: string enum: - qis nullable: false description: 'Optional gateset override for this individual circuit. If not specified, inherits from parent. When set, the circuit must use the appropriate gate format (QIS).' required: - circuit type: object additionalProperties: false NativeCircuit: properties: name: type: string circuit: items: $ref: '#/components/schemas/Gate_NativeGate' type: array description: Circuit gates. Can be either QIS gates or Native gates depending on the gateset property. qubits: type: integer format: int32 registers: $ref: '#/components/schemas/Registers' description: Registers to use in your circuit. Each register is a list of qubit indices (starting from zero). gateset: type: string enum: - native nullable: false description: 'Optional gateset override for this individual circuit. If not specified, inherits from parent. When set, the circuit must use the appropriate gate format (Native).' required: - circuit type: object additionalProperties: false JsonMultiCircuitInput: properties: gateset: type: string enum: - qis - native circuits: items: anyOf: - $ref: '#/components/schemas/QISCircuit' - $ref: '#/components/schemas/NativeCircuit' type: array qubits: type: integer format: int32 minimum: 1 required: - gateset - circuits type: object MultiCircuitJobCreationPayload: properties: name: type: string metadata: $ref: '#/components/schemas/JobMetadata' description: User defined metadata shots: type: integer format: int32 default: 100 minimum: 1 maximum: 1000000 backend: $ref: '#/components/schemas/JobBackends' session_id: type: string settings: properties: error_mitigation: properties: debiasing: type: boolean type: object description: To turn on debiasing, you must request at least 500 shots compilation: properties: opt: type: number format: double precision: type: string type: object type: object dry_run: type: boolean noise: $ref: '#/components/schemas/Noise' type: type: string enum: - ionq.multi-circuit.v1 nullable: false input: $ref: '#/components/schemas/JsonMultiCircuitInput' description: 'Submit multiple circuits in a single job. Each circuit inherits the parent `input.gateset` unless overridden by `circuits[].gateset`.' required: - backend - type - input type: object additionalProperties: false title: JSON Multi Circuit Job description: 'Submit multiple circuits in a single job. Each circuit inherits the parent `input.gateset` unless overridden by `circuits[].gateset`. ' example: type: ionq.multi-circuit.v1 backend: simulator shots: 500 input: gateset: native qubits: 2 circuits: - name: qis circuit override gateset: qis circuit: - gate: h target: 0 - gate: cnot target: 0 control: 1 - name: native circuit from parent circuit: - gate: ms targets: - 0 - 1 phases: - 0 - 0.25 - gate: gpi2 target: 0 phase: 0.75 JobCreationPayload: anyOf: - $ref: '#/components/schemas/CircuitJobCreationPayload' title: Single Circuit - $ref: '#/components/schemas/MultiCircuitJobCreationPayload' title: Multi Circuit - $ref: '#/components/schemas/QuantumFunctionJobCreationPayload' title: Quantum Function - $ref: '#/components/schemas/QctrlQaoaJobCreationPayload' title: QAOA Function example: type: ionq.circuit.v1 input: qubits: 1 gateset: qis circuit: - gate: h target: 0 backend: qpu.forte-1 shots: 500 settings: error_mitigation: debiasing: false IsoTimestamp: type: string Failure: properties: code: type: string enum: - InvalidInput - CompilationError - ContractExpiredError - DebiasingError - InternalError - NotEnoughQubits - OptimizationError - PreflightError - QuantumCircuitComplexityError - QuantumComputerError - QuotaExhaustedError - SimulationError - SimulationTimeout - SystemCancel - TooLongPredictedExecutionTime - TooManyControls - TooManyGates - TooManyShots - UnknownBillingError - UnsupportedGate message: type: string required: - code - message type: object additionalProperties: false CostModel: type: string enum: - quantum_compute_time - execution_time JsonObject: properties: {} type: object additionalProperties: {} BaseJob: properties: id: type: string status: $ref: '#/components/schemas/JobStatus' type: type: string backend: type: string dry_run: type: boolean submitter_id: type: string description: The id of the user who submitted the job project_id: type: string nullable: true parent_job_id: type: string nullable: true session_id: type: string nullable: true metadata: allOf: - $ref: '#/components/schemas/JobMetadata' nullable: true name: type: string nullable: true submitted_at: $ref: '#/components/schemas/IsoTimestamp' started_at: allOf: - $ref: '#/components/schemas/IsoTimestamp' nullable: true completed_at: allOf: - $ref: '#/components/schemas/IsoTimestamp' nullable: true predicted_wait_time_ms: type: integer format: int32 nullable: true predicted_execution_duration_ms: type: integer format: int32 nullable: true execution_duration_ms: type: integer format: int32 nullable: true description: How long the job actually took to run on the QPU. Null if the job hasn't run yet. shots: type: integer format: int32 noise: $ref: '#/components/schemas/Noise' description: Only present in the response when `backend` is simulator. failure: allOf: - $ref: '#/components/schemas/Failure' nullable: true cost_model: $ref: '#/components/schemas/CostModel' description: The billing model used for this job. output: $ref: '#/components/schemas/JsonObject' settings: $ref: '#/components/schemas/JsonObject' stats: $ref: '#/components/schemas/JsonObject' results: allOf: - $ref: '#/components/schemas/JsonObject' nullable: true required: - id - status - type - backend - dry_run - submitter_id - project_id - parent_job_id - session_id - metadata - name - submitted_at - started_at - completed_at - predicted_wait_time_ms - predicted_execution_duration_ms - execution_duration_ms - failure - output - settings - stats - results type: object additionalProperties: false GetJobsResponse: properties: jobs: items: $ref: '#/components/schemas/BaseJob' type: array next: type: string nullable: true required: - jobs - next type: object additionalProperties: false GetJobsQueryParams: properties: ids: items: type: string type: array parent_job_id: type: string status: $ref: '#/components/schemas/JobStatus' target: type: string description: Filter jobs by backend target. Supports single target or comma-separated list of targets. example: simulator session_id: type: string submitter_id: type: string description: The id of another user within a shared project to view their submitted jobs. Ignored if not a project member. limit: type: integer format: int32 next: type: string type: object additionalProperties: false CircuitJobCompilationSettings: properties: precision: type: string opt: type: number format: double gate_basis: type: string service_version: type: string type: object additionalProperties: false CircuitJobSettings: properties: compilation: $ref: '#/components/schemas/CircuitJobCompilationSettings' error_mitigation: properties: debiasing: anyOf: - properties: phi_chi_twirling: properties: p2q: type: number format: double t2q: type: number format: double t1q: type: number format: double type: object type: object - type: boolean type: object type: object additionalProperties: false NumberMap: properties: {} type: object additionalProperties: type: number format: double CircuitJobStats: properties: qubits: type: integer format: int32 circuits: type: integer format: int32 gate_counts: $ref: '#/components/schemas/NumberMap' kwh: type: number format: double predicted_quantum_compute_time_us: type: integer format: int32 billed_quantum_compute_time_us: type: integer format: int32 type: object additionalProperties: false CircuitJobResult: properties: probabilities: properties: url: type: string required: - url type: object histogram: properties: url: type: string required: - url type: object shots: properties: url: type: string required: - url type: object type: object additionalProperties: false GetCircuitJobResponse: properties: id: type: string status: $ref: '#/components/schemas/JobStatus' type: type: string backend: type: string dry_run: type: boolean submitter_id: type: string description: The id of the user who submitted the job project_id: type: string nullable: true parent_job_id: type: string nullable: true session_id: type: string nullable: true metadata: allOf: - $ref: '#/components/schemas/JobMetadata' nullable: true name: type: string nullable: true submitted_at: $ref: '#/components/schemas/IsoTimestamp' started_at: allOf: - $ref: '#/components/schemas/IsoTimestamp' nullable: true completed_at: allOf: - $ref: '#/components/schemas/IsoTimestamp' nullable: true predicted_wait_time_ms: type: integer format: int32 nullable: true predicted_execution_duration_ms: type: integer format: int32 nullable: true execution_duration_ms: type: integer format: int32 nullable: true description: How long the job actually took to run on the QPU. Null if the job hasn't run yet. shots: type: integer format: int32 noise: $ref: '#/components/schemas/Noise' description: Only present in the response when `backend` is simulator. failure: allOf: - $ref: '#/components/schemas/Failure' nullable: true cost_model: $ref: '#/components/schemas/CostModel' description: The billing model used for this job. output: $ref: '#/components/schemas/JsonObject' settings: $ref: '#/components/schemas/CircuitJobSettings' stats: $ref: '#/components/schemas/CircuitJobStats' results: allOf: - $ref: '#/components/schemas/CircuitJobResult' nullable: true child_job_ids: items: type: string type: array nullable: true required: - id - status - type - backend - dry_run - submitter_id - project_id - parent_job_id - session_id - metadata - name - submitted_at - started_at - completed_at - predicted_wait_time_ms - predicted_execution_duration_ms - execution_duration_ms - failure - output - settings - stats - results - child_job_ids type: object additionalProperties: false GetJobResponse: $ref: '#/components/schemas/GetCircuitJobResponse' GetJobCostResponse: properties: dry_run: type: boolean example: false estimated_cost: properties: value: type: number format: double example: 24.83 unit: type: string example: usd required: - value - unit type: object cost: properties: value: type: number format: double example: 24.83 unit: type: string example: usd required: - value - unit type: object required: - dry_run - estimated_cost type: object additionalProperties: false JobCanceledResponse: properties: id: type: string example: 617a1f8b-59d4-435d-aa33-695433d7155e status: type: string enum: - canceled nullable: false required: - id - status type: object additionalProperties: false JobsCanceledResponse: properties: ids: items: type: string type: array example: - 617a1f8b-59d4-435d-aa33-695433d7155e - 617a1f8b-59d4-435d-aa33-695433d7155f status: type: string enum: - canceled nullable: false required: - ids - status type: object additionalProperties: false JobsBulkOperationRequest: properties: ids: items: type: string type: array required: - ids type: object additionalProperties: false JobDeletedResponse: properties: id: type: string example: 617a1f8b-59d4-435d-aa33-695433d7155e status: type: string enum: - deleted nullable: false required: - id - status type: object additionalProperties: false JobsDeletedResponse: properties: ids: items: type: string type: array status: type: string enum: - deleted nullable: false required: - ids - status type: object additionalProperties: false GetJobEstimateQueryParams: properties: backend: $ref: '#/components/schemas/JobBackends' type: type: string default: ionq.circuit.v1 qubits: type: integer format: int32 default: 25 shots: type: integer format: int32 default: 1000 1q_gates: type: integer format: int32 default: 0 2q_gates: type: integer format: int32 default: 0 error_mitigation: type: boolean default: false required: - backend type: object additionalProperties: false GetJobEstimateResponse: properties: input_values: $ref: '#/components/schemas/GetJobEstimateQueryParams' estimated_at: $ref: '#/components/schemas/IsoTimestamp' cost_unit: type: string rate_information: properties: job_cost_minimum: type: number format: double cost_2q_gate: type: number format: double cost_1q_gate: type: number format: double organization: type: string required: - job_cost_minimum - cost_2q_gate - cost_1q_gate - organization type: object estimated_cost: type: number format: double estimated_execution_time: type: number format: double current_predicted_queue_time: type: number format: double required: - input_values - estimated_at - cost_unit - rate_information - estimated_cost - estimated_execution_time - current_predicted_queue_time type: object additionalProperties: false AddJobResultsResponse: properties: job_id: type: string required: - job_id type: object additionalProperties: false JobQCtrlStatus: enum: - running - complete - max_iteration type: string AddJobResultsPayload: properties: processing_status: $ref: '#/components/schemas/JobQCtrlStatus' optimal_cost: type: number format: double optimal_bitstring: type: string required: - processing_status - optimal_cost - optimal_bitstring type: object additionalProperties: false GetResultsResponse: properties: {} type: object additionalProperties: type: number format: double GetVariantResultsResponse: properties: {} type: object additionalProperties: type: number format: double SessionCostLimit: properties: unit: type: string value: type: number format: double required: - unit - value type: object additionalProperties: false SessionSettings: properties: job_count_limit: type: integer format: int32 duration_limit_min: type: integer format: int32 cost_limit: $ref: '#/components/schemas/SessionCostLimit' expires_at: type: string format: date-time type: object additionalProperties: false SessionStatusEnum: enum: - created - started - ended type: string Session: properties: id: type: string description: The id of the session. created_at: type: string format: date-time organization_id: type: string backend: type: string nullable: true project_id: type: string nullable: true creator_id: type: string nullable: true ended_at: type: string format: date-time nullable: true ender_id: type: string nullable: true settings: $ref: '#/components/schemas/SessionSettings' active: type: boolean status: $ref: '#/components/schemas/SessionStatusEnum' started_at: type: string format: date-time nullable: true required: - id - created_at - organization_id - backend - project_id - creator_id - ended_at - ender_id - active - status - started_at type: object additionalProperties: false SessionSettingsRequest: properties: job_count_limit: type: integer format: int32 duration_limit_min: type: integer format: int32 cost_limit: $ref: '#/components/schemas/SessionCostLimit' type: object additionalProperties: false CreateSessionRequest: properties: backend: type: string settings: $ref: '#/components/schemas/SessionSettingsRequest' required: - backend type: object additionalProperties: false SessionsResponse: properties: organization_id: type: string sessions: items: $ref: '#/components/schemas/Session' type: array required: - organization_id - sessions type: object additionalProperties: false GetSessionsQueryParams: properties: active: type: boolean type: object additionalProperties: false QctrlQaoaJobInput: type: object properties: problem_type: type: string enum: - maxcut problem: type: object description: A NetworkX adjacency_graph object example: directed: false multigraph: false graph: [] nodes: - id: 0 - id: 1 - id: 2 adjacency: - - id: 1 - id: 2 - - id: 0 - id: 2 - - id: 0 - id: 1 required: - problem_type - problem QuantumFunctionInput: oneOf: - $ref: '#/components/schemas/HamiltonianEnergyInput' - $ref: '#/components/schemas/GenericQuantumFunctionInput' discriminator: propertyName: type mapping: hamiltonian-energy: '#/components/schemas/HamiltonianEnergyInput' QuantumFunctionJobCreationPayload: type: object properties: name: type: string metadata: $ref: '#/components/schemas/JobMetadata' shots: type: integer format: int32 default: 100 maximum: 1000000 backend: $ref: '#/components/schemas/JobBackends' session_id: type: string settings: type: object properties: error_mitigation: type: object properties: debiasing: type: boolean dry_run: type: boolean type: type: string enum: - quantum-function input: $ref: '#/components/schemas/QuantumFunctionInput' required: - backend - type - input QctrlQaoaJobCreationPayload: type: object description: 'Submit a combinatorial optimization job to solve a maxcut problem using Q-CTRL''s QAOA Solver. See our QAOA Job guide for more infromation. ' properties: name: type: string metadata: $ref: '#/components/schemas/JobMetadata' shots: type: integer format: int32 default: 100 maximum: 1000000 backend: $ref: '#/components/schemas/JobBackends' session_id: type: string settings: type: object properties: error_mitigation: type: object properties: debiasing: type: boolean dry_run: type: boolean type: type: string enum: - qctrl.qaoa.v1 input: $ref: '#/components/schemas/QctrlQaoaJobInput' external_settings: type: object properties: api_credentials: description: API Key for your Q-CTRL Account type: string external_organization: description: Optional unique slug for your target Q-CTRL organization type: string required: - api_credentials required: - backend - type - input - external_settings GroupUsage: description: A group's single date usage properties: amount: description: The cost amount for the group of the given date example: 144.39 type: number group_id: description: The unique ID from the group example: 2bfd0fd5-5854-4916-917f-a907af586755 type: string group_name: description: The group's descriptive name example: Project Jumping Lemming type: string job_count: description: The number of jobs run for the group on the given date example: 9 type: integer time_us: description: The QPU time in microseconds example: 1566154.312523 type: number type: object Usage: description: Single date of QPU usage properties: amount: description: The amount as a cost in USD example: 1614.23 type: number from: description: Date for this group's usage example: '2023-07-01' format: date type: string group_usages: description: The top 5 usage groups in order of cost amount descending items: $ref: '#/components/schemas/GroupUsage' type: array job_count: description: The count of jobs for this group on the given from date example: 10 type: integer time_us: description: The QPU time in microseconds example: 5143166.13413 type: number required: - from - job_count - amount - time_us - group_usages type: object Usages: description: QPU usage details for a given modality and date range. properties: amount_total: description: The total cost amount for the given timeframe, in units given by usage_unit example: 151.31 type: number group_type: $ref: '#/components/schemas/group_by' job_count: description: The total number of jobs run in the timeframe example: 514 type: integer modality: $ref: '#/components/schemas/modality' organization: $ref: '#/components/schemas/organization_id' time_us_total: description: The total QPU time usage for the given timeframe, in microseconds example: 1566154.312523 type: number usage_data: description: The breakdown of usage by group type in date order most to least recent items: $ref: '#/components/schemas/Usage' type: array usage_from: description: Usage beginning RFC 3339 timestamp example: '2025-10-01T00:00:00Z' format: date-time type: string usage_to: description: Usage end RFC 3339 timestamp example: '2025-11-01T00:00:00Z' format: date-time type: string usage_unit: description: The currency of the total and job cost amounts example: USD type: string required: - start_date - end_date - group_type - modality type: object group_by: description: QPU Usage grouping enum: - job - project - user example: project type: string modality: description: Report modality enum: - daily - weekly - monthly example: daily type: string organization_id: description: UUID of an organization. example: 71d164e-6ebe-4126-8839-f1529bb01a00 format: uuid type: string HamiltonianEnergyData: properties: hamiltonian: items: $ref: '#/components/schemas/HamiltonianPauliTerm' title: Hamiltonian type: array ansatz: $ref: '#/components/schemas/Ansatz' linear_constraints: default: [] items: $ref: '#/components/schemas/LinearConstraint' title: Linear Constraints type: array quadratic_constraints: default: [] items: $ref: '#/components/schemas/QuadraticConstraint' title: Quadratic Constraints type: array penalty: default: 0 nullable: true title: Penalty type: number cvar_alpha: default: null nullable: true title: Cvar Alpha type: number required: - hamiltonian - ansatz type: object Ansatz: properties: data: title: Data type: string required: - data type: object HamiltonianPauliTerm: properties: pauli_string: title: Pauli String type: string coefficient: title: Coefficient type: number required: - pauli_string - coefficient type: object LinearConstraint: description: "A class to model linear inequality constraints of the form\n\n.. math::\n\n A x \\leq b." properties: coeffs: items: type: number title: Coeffs type: array rhs: title: Rhs type: number required: - coeffs - rhs type: object QuadraticConstraint: description: "A class to model quadratic inequality constraints of the form\n\n.. math::\n\n x^T P x + r^T x \\leq\ \ c." properties: quadratic_coeff: items: items: type: number type: array title: Quadratic Coeff type: array linear_coeff: items: type: number title: Linear Coeff type: array rhs: title: Rhs type: number required: - quadratic_coeff - linear_coeff - rhs type: object HamiltonianEnergyInput: type: object properties: data: type: object properties: type: type: string enum: - hamiltonian-energy data: $ref: '#/components/schemas/HamiltonianEnergyData' required: - type - data params: type: array items: type: number required: - data GenericQuantumFunctionInput: type: object properties: type: type: string data: type: object params: type: array items: type: number required: - type - data responses: BadRequest: content: application/json: example: error: Bad Request message: '"some-parameter" was invalid.' statusCode: 400 validation: keys: - some-parameter source: params schema: $ref: '#/components/schemas/BadRequestError' description: Invalid request parameters Error: content: application/json: example: error: Internal Server Error message: Internal service outage. Visit https://status.ionq.co/ to track this incident. statusCode: 500 schema: $ref: '#/components/schemas/Error' description: Error NotFound: content: application/json: example: error: Not Found Error message: Resource not found. See https://docs.ionq.com/ for details, or email support@ionq.co for help. statusCode: 404 schema: $ref: '#/components/schemas/Error' description: Resource was not found. Unauthorized: content: application/json: example: error: Unauthorized Error message: Invalid key provided. See https://docs.ionq.com/#authentication for details, or email support@ionq.co for help. statusCode: 401 schema: $ref: '#/components/schemas/Error' description: Request was not authorized. Whoami: content: application/json: schema: $ref: '#/components/schemas/Whoami' description: Successfully retrieved a current of key from this session. GetBackend: content: application/json: schema: $ref: '#/components/schemas/Backend' description: Successfully retrieved backend. GetCharacterization: content: application/json: schema: $ref: '#/components/schemas/Characterization' description: Successfully retrieved current characterization ListBackends: content: application/json: schema: description: The list of backends. items: $ref: '#/components/schemas/Backend' type: array description: Successfully retrieved backend. ListCharacterizations: content: application/json: schema: description: Response body from requesting characterization data. properties: characterizations: description: A page of characterizations measurements. items: $ref: '#/components/schemas/Characterization' type: array pages: description: The number of remaining pages of characterization measurements. type: integer required: - characterizations type: object description: Successfully retrieved characterizations. UsagesResponse: content: application/json: schema: $ref: '#/components/schemas/Usages' description: Successfully retrieved a list of projects. examples: Metadata: value: input: '{ "format": "ionq.circuit.v0", "qubits": 1, "circuit": [ { "gate": "h", "target": 0 } ] }' metadata: bar: 2 foo: 1 securitySchemes: apiKeyAuth: description: 'API keys are associated with a user and can be created on the [IonQ Quantum Cloud](https://cloud.ionq.com) application. To authenticate, prefix your API Key with `apiKey ` and place it in the `Authorization` request header. Ex: `Authorization: apiKey your-api-key`' in: header name: Authorization type: apiKey parameters: backend: description: A backend where jobs can run on. in: path name: backend required: true schema: enum: - qpu.aria-1 - qpu.aria-2 - qpu.forte-1 - qpu.forte-enterprise-1 - qpu.forte-enterprise-2 - qpu.forte-enterprise-3 type: string pagination-limit: in: query name: limit schema: $ref: '#/components/schemas/pagination-limit' pagination-next: in: query name: next schema: $ref: '#/components/schemas/pagination-next' pagination-page: in: query name: page schema: $ref: '#/components/schemas/pagination-page' uuid: description: A UUID identifying a specific resource example: 617a1f8b-59d4-435d-aa33-695433d7155e in: path name: UUID required: true schema: format: uuid type: string organization_id: description: "The UUID of the organization \u2014 this UUID is provided in the response on organization creation." example: 71d164e-6ebe-4126-8839-f1529bb01a00 in: path name: organization_id required: true schema: format: uuid type: string requestBodies: {} headers: {}