{
"components": {
"headers": {
"IBMAPIVersion": {
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
"ServiceCRN": {
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
}
},
"parameters": {},
"schemas": {
"Backend": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Additional details related to the backend status.",
"type": "string"
},
"name": {
"description": "Name of the backend",
"examples": ["ibm_bromont"],
"type": "string"
},
"status": {
"description": "online (you can send jobs), offline (you cannot send jobs) and paused (you cannot send jobs).",
"enum": ["online", "offline", "paused"],
"examples": ["online"],
"type": "string"
},
"version": {
"description": "Version of the backend",
"examples": ["1.0.0"],
"type": "string"
}
},
"required": ["name", "status"],
"type": "object"
},
"BackendsResponse": {
"additionalProperties": false,
"properties": {
"backends": {
"description": "A list of backend names available for direct access.",
"items": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Additional details related to the backend status.",
"type": "string"
},
"name": {
"description": "Name of the backend",
"examples": ["ibm_bromont"],
"type": "string"
},
"status": {
"description": "online (you can send jobs), offline (you cannot send jobs) and paused (you cannot send jobs).",
"enum": ["online", "offline", "paused"],
"examples": ["online"],
"type": "string"
},
"version": {
"description": "Version of the backend",
"examples": ["1.0.0"],
"type": "string"
}
},
"required": ["name", "status"],
"type": "object"
},
"type": ["array", "null"]
}
},
"required": ["backends"],
"type": "object"
},
"Error": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"HTTPError": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
},
"JobResponse": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"type": "string"
},
"created_time": {
"description": "Time when job was created.",
"format": "date-time",
"type": "string"
},
"end_time": {
"description": "Time when job reached a terminal status.",
"format": "date-time",
"type": "string"
},
"id": { "description": "Unique ID for the Job (UUID V4)", "type": "string" },
"log_level": {
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"type": "string"
},
"reason_code": {
"description": "This field will be set to a numeric error code when the job has failed.",
"format": "int64",
"type": "integer"
},
"reason_message": {
"description": "Reason message explaining why the job is in a particular status. Ex: If a job has Failed, this field will have the error message.",
"type": "string"
},
"reason_solution": {
"description": "Next steps to take in case of failure.",
"type": "string"
},
"status": {
"description": "Current status of the job.",
"enum": ["Running", "Completed", "Cancelled", "Failed"],
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled.",
"format": "int64",
"type": "integer"
},
"usage": {
"description": "Job usage details.",
"additionalProperties": false,
"properties": {
"quantum_nanoseconds": {
"description": "Execution time on quantum device in nanoseconds.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"required": ["id", "program_id", "backend", "status", "created_time"],
"type": "object"
},
"JobsResponse": {
"additionalProperties": false,
"properties": {
"jobs": {
"items": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"type": "string"
},
"created_time": {
"description": "Time when job was created.",
"format": "date-time",
"type": "string"
},
"end_time": {
"description": "Time when job reached a terminal status.",
"format": "date-time",
"type": "string"
},
"id": { "description": "Unique ID for the Job (UUID V4)", "type": "string" },
"log_level": {
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"type": "string"
},
"reason_code": {
"description": "This field will be set to a numeric error code when the job has failed.",
"format": "int64",
"type": "integer"
},
"reason_message": {
"description": "Reason message explaining why the job is in a particular status. Ex: If a job has Failed, this field will have the error message.",
"type": "string"
},
"reason_solution": {
"description": "Next steps to take in case of failure.",
"type": "string"
},
"status": {
"description": "Current status of the job.",
"enum": ["Running", "Completed", "Cancelled", "Failed"],
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled.",
"format": "int64",
"type": "integer"
},
"usage": {
"description": "Job usage details.",
"additionalProperties": false,
"properties": {
"quantum_nanoseconds": {
"description": "Execution time on quantum device in nanoseconds.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"required": ["id", "program_id", "backend", "status", "created_time"],
"type": "object"
},
"type": ["array", "null"]
}
},
"required": ["jobs"],
"type": "object"
},
"Reservation": {
"additionalProperties": false,
"properties": {
"reservation_creation_time": {
"description": "Timestamp (RFC3339) the reservation was created",
"format": "date-time",
"type": "string"
},
"reservation_token": { "description": "reservation token", "type": "string" }
},
"required": ["reservation_token", "reservation_creation_time"],
"type": "object"
},
"ReservationRequestBody": {
"additionalProperties": false,
"properties": {
"accepted_wait_time": {
"description": "time (in seconds) to wait for reservation to be created",
"format": "float",
"minimum": 1,
"type": "number"
},
"backend_name": {
"description": "backend to reserve",
"maxLength": 64,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-_]*$",
"type": "string"
},
"ttl_in_seconds": {
"description": "time (in seconds) to live of reservation",
"format": "float",
"minimum": 1,
"type": "number"
}
},
"required": ["backend_name", "ttl_in_seconds"],
"type": "object"
},
"RunJobBody": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"id": {
"description": "Job identifier. Recommended to be UUID",
"maxLength": 36,
"minLength": 1,
"type": "string"
},
"log_level": {
"default": "warning",
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled. It is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job.",
"format": "int64",
"minimum": 1,
"type": "integer"
}
},
"required": ["id", "program_id", "backend", "timeout_secs", "storage"],
"type": "object"
},
"Storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": ["crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": ["crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": ["crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"StorageOption": {
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": ["crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"Target": {
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"Usage": {
"additionalProperties": false,
"properties": {
"quantum_nanoseconds": {
"description": "Execution time on quantum device in nanoseconds.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"VersionResponse": {
"additionalProperties": false,
"properties": {
"version": { "examples": ["{\"version\": \"2025-08-15\"}"], "type": "string" }
},
"required": ["version"],
"type": "object"
},
"VersionsResponse": {
"additionalProperties": false,
"properties": {
"versions": {
"examples": [["{ \"versions\": [\"2025-08-15\"]}"]],
"items": { "type": "string" },
"type": ["array", "null"]
}
},
"required": ["versions"],
"type": "object"
}
},
"securitySchemes": {
"IAMBearerTokenAuth": {
"bearerFormat": "JWT",
"description": "Use the API key generated during onboarding to obtain an access token from IBM Cloud IAM service. More info: https://cloud.ibm.com/docs/account?topic=account-iamtoken_from_apikey#iamtoken-from-apikey-api. Include the access token in the Authorization header as 'Bearer {access_token}'.",
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"contact": {
"name": "IBM Quantum Support",
"url": "https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-support"
},
"description": "These APIs are intended to be used by scheduler applications to schedule jobs on a quantum device via Qiskit Runtime primitives.",
"license": {
"name": "IBM",
"url": "https://www.ibm.com/support/customer/csol/terms/?id=i126-9425"
},
"termsOfService": "https://www.ibm.com/support/customer/csol/terms/?id=i126-9425",
"title": "IBM Quantum Qiskit Runtime Direct Access API",
"version": "2025-08-15"
},
"openapi": "3.1.0",
"paths": {
"/v1/backends": {
"get": {
"description": "Returns a list of backends enabled for direct access.",
"operationId": "backends.list",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"backends": {
"description": "A list of backend names available for direct access.",
"items": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Additional details related to the backend status.",
"type": "string"
},
"name": {
"description": "Name of the backend",
"examples": ["ibm_bromont"],
"type": "string"
},
"status": {
"description": "online (you can send jobs), offline (you cannot send jobs) and paused (you cannot send jobs).",
"enum": ["online", "offline", "paused"],
"examples": ["online"],
"type": "string"
},
"version": {
"description": "Version of the backend",
"examples": ["1.0.0"],
"type": "string"
}
},
"required": ["name", "status"],
"type": "object"
},
"type": ["array", "null"]
}
},
"required": ["backends"],
"type": "object"
}
}
},
"description": "Returned when backends were retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get list of backends",
"tags": ["Backends"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-backend.list" }] },
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-backend.list" }]
}
}
},
"/v1/backends/{backend-name}": {
"get": {
"description": "Returns details of a backend.",
"operationId": "backend.read",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{
"example": "ibm_bromont",
"in": "path",
"name": "backend-name",
"required": true,
"schema": { "examples": ["ibm_bromont"], "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Additional details related to the backend status.",
"type": "string"
},
"name": {
"description": "Name of the backend",
"examples": ["ibm_bromont"],
"type": "string"
},
"status": {
"description": "online (you can send jobs), offline (you cannot send jobs) and paused (you cannot send jobs).",
"enum": ["online", "offline", "paused"],
"examples": ["online"],
"type": "string"
},
"version": {
"description": "Version of the backend",
"examples": ["1.0.0"],
"type": "string"
}
},
"required": ["name", "status"],
"type": "object"
}
}
},
"description": "Returned when backend details was retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when backend is not found."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get backend details",
"tags": ["Backends"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-backend.read" }] },
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-backend.read" }]
}
}
},
"/v1/backends/{backend-name}/configuration": {
"get": {
"description": "Returns configuration of a backend.",
"operationId": "backend-configuration.read",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{ "$ref": "" },
{
"example": "ibm_bromont",
"in": "path",
"name": "backend-name",
"required": true,
"schema": { "examples": ["ibm_bromont"], "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://www.qiskit.org/schemas/backend_config_schema.json",
"description": "Qiskit device backend configuration",
"version": "1.6.0",
"definitions": {
"hamiltonian": {
"type": "object",
"description": "Hamiltonian of the backend",
"required": ["h_latex"],
"properties": {
"h_latex": {
"type": "string",
"description": "The Hamiltonian in latex form"
},
"h_str": {
"type": "array",
"items": { "type": "string" },
"description": "The Hamiltonian in machine readable form"
},
"vars": { "type": "object", "description": "Variables in the h_str" },
"osc": {
"type": "object",
"description": "Number of levels for each oscillator mode"
}
}
},
"coreconfig": {
"type": "object",
"required": [
"backend_name",
"backend_version",
"n_qubits",
"basis_gates",
"gates",
"local",
"simulator",
"conditional",
"memory",
"max_shots"
],
"properties": {
"backend_name": { "type": "string", "description": "Backend name" },
"sample_name": { "type": "string", "description": "Sample name" },
"backend_version": {
"type": "string",
"pattern": "[0-9]+.[0-9]+.[0-9]+$",
"description": "Backend version in the form X.X.X"
},
"n_qubits": {
"type": "integer",
"description": "Number of qubits",
"minimum": 1,
"default": 1
},
"basis_gates": {
"type": "array",
"description": "List of basis gates names on the backend",
"items": { "type": "string" },
"minItems": 0
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "Array grouping qubits that are physically coupled together on the backend"
},
"gates": {
"type": "array",
"description": "List of basis gates on the backend",
"items": {
"type": "object",
"required": ["name", "parameters", "qasm_def"],
"properties": {
"name": {
"type": "string",
"description": "The gate name as it will be referred to in QASM"
},
"parameters": {
"type": "array",
"minItems": 0,
"items": { "type": "string" },
"description": "Variable names for the gate parameters (if any)"
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "List of qubit groupings which are coupled by this gate"
},
"qasm_def": {
"type": "string",
"description": "Definition of this gate in terms of QASM primitives U and CX"
},
"conditional": {
"type": "boolean",
"description": "This specified gate supports conditional operations (true/false). If this is not specified, then the gate inherits the conditional property of the backend.",
"default": false
},
"latency_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "enum": [0, 1] }
},
"description": "An array of dimension len(coupling_map) X n_registers that specifies (1 - fast, 0 - slow) the register latency conditional operations on the gate"
},
"description": {
"type": "string",
"description": "Description of the gate operation"
}
}
},
"minItems": 0
},
"local": {
"type": "boolean",
"description": "Backend is local or remote (true/false)"
},
"simulator": {
"type": "boolean",
"description": "Backend is a simulator (true/false)",
"default": false
},
"conditional": {
"type": "boolean",
"description": "Backend supports conditional operations (true/false)",
"default": false
},
"memory": {
"type": "boolean",
"description": "Backend supports memory (true/false)",
"default": false
},
"max_shots": {
"type": "integer",
"description": "Maximum number of shots supported",
"minimum": 1
},
"max_experiments": {
"type": "integer",
"description": "Maximum number of experiments supported",
"minimum": 1
},
"n_registers": {
"type": "integer",
"description": "Number of register slots available for feedback (if conditional is true)",
"minimum": 1,
"default": 1
},
"register_map": {
"type": "array",
"minItems": 1,
"items": { "type": "array", "minItems": 1, "items": { "enum": [0, 1] } },
"description": "An array of dimension n_qubits X n_registers that specifies whether a qubit can store a measurement in a certain register slot"
},
"configurable": {
"type": "boolean",
"description": "Backend is configurable, if the backend is a simulator (true/false)",
"default": false
},
"credits_required": {
"type": "boolean",
"description": "Backend requires credits to run a job (true/false)",
"default": false
},
"online_date": {
"type": "string",
"format": "date-time",
"description": "Date the backend went online"
},
"display_name": {
"type": "string",
"description": "Alternate name field for the backend"
},
"description": {
"type": "string",
"description": "Description of the backend"
},
"tags": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": { "type": "string", "examples": ["credits_required"] }
},
"rep_delay_range": {
"type": "array",
"minItems": 0,
"description": "Range of delay times between programs (microseconds) allowed by backend.",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number", "minimum": 0 }
}
},
"default_rep_delay": {
"type": "number",
"description": "Default rep delay.",
"minimum": 0
},
"dynamic_reprate_enabled": {
"type": "boolean",
"description": "Whether delay between programs can be set dynamically using 'rep_delay').",
"default": false
},
"measure_esp_enabled": {
"type": "boolean",
"description": "Whether ESP readout is supported by the backend.",
"default": false
},
"supported_instructions": {
"type": "array",
"minItems": 0,
"description": "Instructions supported by the backend.",
"items": { "type": "string" }
},
"supported_features": {
"type": "array",
"minItems": 0,
"description": "Array of features supported by the backend such as qobj, qasm3, etc.",
"items": { "type": "string" }
},
"quantum_volume": {
"type": "integer",
"description": "Backend quantum volume",
"minimum": 1
},
"processor_type": {
"type": "object",
"required": ["family", "revision"],
"properties": {
"family": {
"type": "string",
"description": "Processor family indicates quantum chip architecture"
},
"revision": {
"type": "string",
"description": "Revision number reflects design variants within a given processor family. Is typically a semantic versioning value without the patch value, eg., \"1.0\"."
},
"segment": {
"type": "string",
"description": "Segment, if indicated, is used to distinguish different subsets of the qubit fabric/chip"
}
}
},
"qubit_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the qubit LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"meas_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the measurement LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"timing_constraints": {
"type": "object",
"properties": {
"granularity": {
"type": "integer",
"description": "Waveform memory data chunk size"
},
"min_length": {
"type": "integer",
"description": "Minimum number of samples required to define a pulse"
},
"pulse_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of pulse channel in units of dt"
},
"acquire_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of acquisition channel in units of dt"
}
}
}
}
},
"openpulse_config": {
"required": [
"open_pulse",
"n_uchannels",
"hamiltonian",
"u_channel_lo",
"meas_levels",
"qubit_lo_range",
"meas_lo_range",
"dt",
"dtm",
"rep_times",
"meas_kernels",
"discriminators"
],
"properties": {
"open_pulse": {
"enum": [true],
"description": "The backend supports openPulse (true/false)"
},
"n_uchannels": {
"type": "integer",
"description": "Number of additional control channels",
"minimum": 0
},
"hamiltonian": {
"type": "object",
"required": ["h_latex"],
"description": "Hamiltonian of the backend",
"properties": {
"h_latex": {
"type": "string",
"description": "The Hamiltonian in latex form"
},
"h_str": {
"type": "array",
"items": { "type": "string" },
"description": "The Hamiltonian in machine readable form"
},
"vars": { "type": "object", "description": "Variables in the h_str" },
"osc": {
"type": "object",
"description": "Number of levels for each oscillator mode"
}
}
},
"u_channel_lo": {
"type": "array",
"minItems": 0,
"description": "Relationship of the U Channel LO's in terms of the qubit LO's",
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"q": { "type": "integer" },
"scale": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "oneOf": [{ "type": "number" }, { "type": "number" }] }
}
}
}
}
},
"meas_levels": {
"type": "array",
"minItems": 1,
"maxitems": 3,
"description": "Available measurement levels on the backend",
"items": { "type": "integer", "minimum": 0, "maximum": 2 }
},
"dt": {
"type": "number",
"description": "Time discretization for the drive and U channels",
"minimum": 0
},
"dtm": {
"type": "number",
"description": "Time discretization for the measurement channels",
"minimum": 0
},
"rep_times": {
"type": "array",
"minItems": 1,
"description": "Program execution times (microseconds) supported by backend.",
"items": { "type": "number", "minimum": 0 }
},
"meas_map": {
"type": "array",
"minItems": 1,
"description": "Grouping of measurement which are multiplexed",
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer", "minimum": 0 }
}
},
"channel_bandwidth": {
"type": "array",
"minItems": 2,
"description": "Bandwidth of all channels (qubit,measurement and U)",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"meas_kernels": {
"type": "array",
"minItems": 1,
"description": "Available measurement kernels",
"items": { "type": "string" }
},
"discriminators": {
"type": "array",
"minItems": 1,
"description": "Available discriminators",
"items": { "type": "string" }
},
"acquisition_latency": {
"type": "array",
"minItems": 1,
"description": "Array of dimension n_qubits x n_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m.",
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
}
},
"conditional_latency": {
"type": "array",
"minItems": 1,
"description": "Array of dimension n_channels [d->u->m] x n_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m",
"items": { "type": "array", "minItems": 1, "items": { "type": "number" } }
},
"parametric_pulses": {
"type": "array",
"minItems": 0,
"description": "A list of available parametric pulse shapes",
"items": { "type": "string" }
},
"channels": {
"type": "object",
"patternProperties": {
"^[a-z0-9]+$": {
"type": "object",
"properties": {
"type": { "type": "string" },
"purpose": { "type": "string" },
"operates": {
"type": "object",
"properties": {
"qubits": {
"type": "array",
"items": { "type": "integer", "minimum": 0 }
}
}
}
}
}
},
"description": "A dictionary where each entry represents a channel configuration and contains configuration values such as the channel's mapping to qubits."
}
}
},
"gateconfig": {
"type": "object",
"required": ["name", "parameters", "qasm_def"],
"properties": {
"name": {
"type": "string",
"description": "The gate name as it will be referred to in QASM"
},
"parameters": {
"type": "array",
"minItems": 0,
"items": { "type": "string" },
"description": "Variable names for the gate parameters (if any)"
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "List of qubit groupings which are coupled by this gate"
},
"qasm_def": {
"type": "string",
"description": "Definition of this gate in terms of QASM primitives U and CX"
},
"conditional": {
"type": "boolean",
"description": "This specified gate supports conditional operations (true/false). If this is not specified, then the gate inherits the conditional property of the backend.",
"default": false
},
"latency_map": {
"type": "array",
"minItems": 1,
"items": { "type": "array", "minItems": 1, "items": { "enum": [0, 1] } },
"description": "An array of dimension len(coupling_map) X n_registers that specifies (1 - fast, 0 - slow) the register latency conditional operations on the gate"
},
"description": {
"type": "string",
"description": "Description of the gate operation"
}
}
},
"complexnumber": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "oneOf": [{ "type": "number" }, { "type": "number" }] }
}
},
"oneOf": [
{
"allOf": [
{
"type": "object",
"required": [
"backend_name",
"backend_version",
"n_qubits",
"basis_gates",
"gates",
"local",
"simulator",
"conditional",
"memory",
"max_shots"
],
"properties": {
"backend_name": { "type": "string", "description": "Backend name" },
"sample_name": { "type": "string", "description": "Sample name" },
"backend_version": {
"type": "string",
"pattern": "[0-9]+.[0-9]+.[0-9]+$",
"description": "Backend version in the form X.X.X"
},
"n_qubits": {
"type": "integer",
"description": "Number of qubits",
"minimum": 1,
"default": 1
},
"basis_gates": {
"type": "array",
"description": "List of basis gates names on the backend",
"items": { "type": "string" },
"minItems": 0
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "Array grouping qubits that are physically coupled together on the backend"
},
"gates": {
"type": "array",
"description": "List of basis gates on the backend",
"items": {
"type": "object",
"required": ["name", "parameters", "qasm_def"],
"properties": {
"name": {
"type": "string",
"description": "The gate name as it will be referred to in QASM"
},
"parameters": {
"type": "array",
"minItems": 0,
"items": { "type": "string" },
"description": "Variable names for the gate parameters (if any)"
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "List of qubit groupings which are coupled by this gate"
},
"qasm_def": {
"type": "string",
"description": "Definition of this gate in terms of QASM primitives U and CX"
},
"conditional": {
"type": "boolean",
"description": "This specified gate supports conditional operations (true/false). If this is not specified, then the gate inherits the conditional property of the backend.",
"default": false
},
"latency_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "enum": [0, 1] }
},
"description": "An array of dimension len(coupling_map) X n_registers that specifies (1 - fast, 0 - slow) the register latency conditional operations on the gate"
},
"description": {
"type": "string",
"description": "Description of the gate operation"
}
}
},
"minItems": 0
},
"local": {
"type": "boolean",
"description": "Backend is local or remote (true/false)"
},
"simulator": {
"type": "boolean",
"description": "Backend is a simulator (true/false)",
"default": false
},
"conditional": {
"type": "boolean",
"description": "Backend supports conditional operations (true/false)",
"default": false
},
"memory": {
"type": "boolean",
"description": "Backend supports memory (true/false)",
"default": false
},
"max_shots": {
"type": "integer",
"description": "Maximum number of shots supported",
"minimum": 1
},
"max_experiments": {
"type": "integer",
"description": "Maximum number of experiments supported",
"minimum": 1
},
"n_registers": {
"type": "integer",
"description": "Number of register slots available for feedback (if conditional is true)",
"minimum": 1,
"default": 1
},
"register_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "enum": [0, 1] }
},
"description": "An array of dimension n_qubits X n_registers that specifies whether a qubit can store a measurement in a certain register slot"
},
"configurable": {
"type": "boolean",
"description": "Backend is configurable, if the backend is a simulator (true/false)",
"default": false
},
"credits_required": {
"type": "boolean",
"description": "Backend requires credits to run a job (true/false)",
"default": false
},
"online_date": {
"type": "string",
"format": "date-time",
"description": "Date the backend went online"
},
"display_name": {
"type": "string",
"description": "Alternate name field for the backend"
},
"description": {
"type": "string",
"description": "Description of the backend"
},
"tags": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": { "type": "string", "examples": ["credits_required"] }
},
"rep_delay_range": {
"type": "array",
"minItems": 0,
"description": "Range of delay times between programs (microseconds) allowed by backend.",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number", "minimum": 0 }
}
},
"default_rep_delay": {
"type": "number",
"description": "Default rep delay.",
"minimum": 0
},
"dynamic_reprate_enabled": {
"type": "boolean",
"description": "Whether delay between programs can be set dynamically using 'rep_delay').",
"default": false
},
"measure_esp_enabled": {
"type": "boolean",
"description": "Whether ESP readout is supported by the backend.",
"default": false
},
"supported_instructions": {
"type": "array",
"minItems": 0,
"description": "Instructions supported by the backend.",
"items": { "type": "string" }
},
"supported_features": {
"type": "array",
"minItems": 0,
"description": "Array of features supported by the backend such as qobj, qasm3, etc.",
"items": { "type": "string" }
},
"quantum_volume": {
"type": "integer",
"description": "Backend quantum volume",
"minimum": 1
},
"processor_type": {
"type": "object",
"required": ["family", "revision"],
"properties": {
"family": {
"type": "string",
"description": "Processor family indicates quantum chip architecture"
},
"revision": {
"type": "string",
"description": "Revision number reflects design variants within a given processor family. Is typically a semantic versioning value without the patch value, eg., \"1.0\"."
},
"segment": {
"type": "string",
"description": "Segment, if indicated, is used to distinguish different subsets of the qubit fabric/chip"
}
}
},
"qubit_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the qubit LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"meas_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the measurement LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"timing_constraints": {
"type": "object",
"properties": {
"granularity": {
"type": "integer",
"description": "Waveform memory data chunk size"
},
"min_length": {
"type": "integer",
"description": "Minimum number of samples required to define a pulse"
},
"pulse_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of pulse channel in units of dt"
},
"acquire_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of acquisition channel in units of dt"
}
}
}
}
},
{
"required": [
"open_pulse",
"n_uchannels",
"hamiltonian",
"u_channel_lo",
"meas_levels",
"qubit_lo_range",
"meas_lo_range",
"dt",
"dtm",
"rep_times",
"meas_kernels",
"discriminators"
],
"properties": {
"open_pulse": {
"enum": [true],
"description": "The backend supports openPulse (true/false)"
},
"n_uchannels": {
"type": "integer",
"description": "Number of additional control channels",
"minimum": 0
},
"hamiltonian": {
"type": "object",
"required": ["h_latex"],
"description": "Hamiltonian of the backend",
"properties": {
"h_latex": {
"type": "string",
"description": "The Hamiltonian in latex form"
},
"h_str": {
"type": "array",
"items": { "type": "string" },
"description": "The Hamiltonian in machine readable form"
},
"vars": {
"type": "object",
"description": "Variables in the h_str"
},
"osc": {
"type": "object",
"description": "Number of levels for each oscillator mode"
}
}
},
"u_channel_lo": {
"type": "array",
"minItems": 0,
"description": "Relationship of the U Channel LO's in terms of the qubit LO's",
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"q": { "type": "integer" },
"scale": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"oneOf": [{ "type": "number" }, { "type": "number" }]
}
}
}
}
}
},
"meas_levels": {
"type": "array",
"minItems": 1,
"maxitems": 3,
"description": "Available measurement levels on the backend",
"items": { "type": "integer", "minimum": 0, "maximum": 2 }
},
"dt": {
"type": "number",
"description": "Time discretization for the drive and U channels",
"minimum": 0
},
"dtm": {
"type": "number",
"description": "Time discretization for the measurement channels",
"minimum": 0
},
"rep_times": {
"type": "array",
"minItems": 1,
"description": "Program execution times (microseconds) supported by backend.",
"items": { "type": "number", "minimum": 0 }
},
"meas_map": {
"type": "array",
"minItems": 1,
"description": "Grouping of measurement which are multiplexed",
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer", "minimum": 0 }
}
},
"channel_bandwidth": {
"type": "array",
"minItems": 2,
"description": "Bandwidth of all channels (qubit,measurement and U)",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"meas_kernels": {
"type": "array",
"minItems": 1,
"description": "Available measurement kernels",
"items": { "type": "string" }
},
"discriminators": {
"type": "array",
"minItems": 1,
"description": "Available discriminators",
"items": { "type": "string" }
},
"acquisition_latency": {
"type": "array",
"minItems": 1,
"description": "Array of dimension n_qubits x n_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m.",
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
}
},
"conditional_latency": {
"type": "array",
"minItems": 1,
"description": "Array of dimension n_channels [d->u->m] x n_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m",
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "number" }
}
},
"parametric_pulses": {
"type": "array",
"minItems": 0,
"description": "A list of available parametric pulse shapes",
"items": { "type": "string" }
},
"channels": {
"type": "object",
"patternProperties": {
"^[a-z0-9]+$": {
"type": "object",
"properties": {
"type": { "type": "string" },
"purpose": { "type": "string" },
"operates": {
"type": "object",
"properties": {
"qubits": {
"type": "array",
"items": { "type": "integer", "minimum": 0 }
}
}
}
}
}
},
"description": "A dictionary where each entry represents a channel configuration and contains configuration values such as the channel's mapping to qubits."
}
}
}
]
},
{
"allOf": [
{
"type": "object",
"required": [
"backend_name",
"backend_version",
"n_qubits",
"basis_gates",
"gates",
"local",
"simulator",
"conditional",
"memory",
"max_shots"
],
"properties": {
"backend_name": { "type": "string", "description": "Backend name" },
"sample_name": { "type": "string", "description": "Sample name" },
"backend_version": {
"type": "string",
"pattern": "[0-9]+.[0-9]+.[0-9]+$",
"description": "Backend version in the form X.X.X"
},
"n_qubits": {
"type": "integer",
"description": "Number of qubits",
"minimum": 1,
"default": 1
},
"basis_gates": {
"type": "array",
"description": "List of basis gates names on the backend",
"items": { "type": "string" },
"minItems": 0
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "Array grouping qubits that are physically coupled together on the backend"
},
"gates": {
"type": "array",
"description": "List of basis gates on the backend",
"items": {
"type": "object",
"required": ["name", "parameters", "qasm_def"],
"properties": {
"name": {
"type": "string",
"description": "The gate name as it will be referred to in QASM"
},
"parameters": {
"type": "array",
"minItems": 0,
"items": { "type": "string" },
"description": "Variable names for the gate parameters (if any)"
},
"coupling_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "type": "integer" }
},
"description": "List of qubit groupings which are coupled by this gate"
},
"qasm_def": {
"type": "string",
"description": "Definition of this gate in terms of QASM primitives U and CX"
},
"conditional": {
"type": "boolean",
"description": "This specified gate supports conditional operations (true/false). If this is not specified, then the gate inherits the conditional property of the backend.",
"default": false
},
"latency_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "enum": [0, 1] }
},
"description": "An array of dimension len(coupling_map) X n_registers that specifies (1 - fast, 0 - slow) the register latency conditional operations on the gate"
},
"description": {
"type": "string",
"description": "Description of the gate operation"
}
}
},
"minItems": 0
},
"local": {
"type": "boolean",
"description": "Backend is local or remote (true/false)"
},
"simulator": {
"type": "boolean",
"description": "Backend is a simulator (true/false)",
"default": false
},
"conditional": {
"type": "boolean",
"description": "Backend supports conditional operations (true/false)",
"default": false
},
"memory": {
"type": "boolean",
"description": "Backend supports memory (true/false)",
"default": false
},
"max_shots": {
"type": "integer",
"description": "Maximum number of shots supported",
"minimum": 1
},
"max_experiments": {
"type": "integer",
"description": "Maximum number of experiments supported",
"minimum": 1
},
"n_registers": {
"type": "integer",
"description": "Number of register slots available for feedback (if conditional is true)",
"minimum": 1,
"default": 1
},
"register_map": {
"type": "array",
"minItems": 1,
"items": {
"type": "array",
"minItems": 1,
"items": { "enum": [0, 1] }
},
"description": "An array of dimension n_qubits X n_registers that specifies whether a qubit can store a measurement in a certain register slot"
},
"configurable": {
"type": "boolean",
"description": "Backend is configurable, if the backend is a simulator (true/false)",
"default": false
},
"credits_required": {
"type": "boolean",
"description": "Backend requires credits to run a job (true/false)",
"default": false
},
"online_date": {
"type": "string",
"format": "date-time",
"description": "Date the backend went online"
},
"display_name": {
"type": "string",
"description": "Alternate name field for the backend"
},
"description": {
"type": "string",
"description": "Description of the backend"
},
"tags": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": { "type": "string", "examples": ["credits_required"] }
},
"rep_delay_range": {
"type": "array",
"minItems": 0,
"description": "Range of delay times between programs (microseconds) allowed by backend.",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number", "minimum": 0 }
}
},
"default_rep_delay": {
"type": "number",
"description": "Default rep delay.",
"minimum": 0
},
"dynamic_reprate_enabled": {
"type": "boolean",
"description": "Whether delay between programs can be set dynamically using 'rep_delay').",
"default": false
},
"measure_esp_enabled": {
"type": "boolean",
"description": "Whether ESP readout is supported by the backend.",
"default": false
},
"supported_instructions": {
"type": "array",
"minItems": 0,
"description": "Instructions supported by the backend.",
"items": { "type": "string" }
},
"supported_features": {
"type": "array",
"minItems": 0,
"description": "Array of features supported by the backend such as qobj, qasm3, etc.",
"items": { "type": "string" }
},
"quantum_volume": {
"type": "integer",
"description": "Backend quantum volume",
"minimum": 1
},
"processor_type": {
"type": "object",
"required": ["family", "revision"],
"properties": {
"family": {
"type": "string",
"description": "Processor family indicates quantum chip architecture"
},
"revision": {
"type": "string",
"description": "Revision number reflects design variants within a given processor family. Is typically a semantic versioning value without the patch value, eg., \"1.0\"."
},
"segment": {
"type": "string",
"description": "Segment, if indicated, is used to distinguish different subsets of the qubit fabric/chip"
}
}
},
"qubit_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the qubit LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"meas_lo_range": {
"type": "array",
"minItems": 1,
"description": "Frequency range for the measurement LO",
"items": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": { "type": "number" }
}
},
"timing_constraints": {
"type": "object",
"properties": {
"granularity": {
"type": "integer",
"description": "Waveform memory data chunk size"
},
"min_length": {
"type": "integer",
"description": "Minimum number of samples required to define a pulse"
},
"pulse_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of pulse channel in units of dt"
},
"acquire_alignment": {
"type": "integer",
"description": "Instruction triggering time resolution of acquisition channel in units of dt"
}
}
}
}
},
{
"required": ["open_pulse"],
"properties": { "open_pulse": { "enum": [false] } }
}
]
}
]
}
}
},
"description": "Returned when backend configuration was retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when backend is not found."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get backend configuration",
"tags": ["Backends"],
"x-ibm-events": {
"events": [{ "name": "quantum-computing.direct-access-backend-configuration.read" }]
},
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-backend-configuration.read" }]
}
}
},
"/v1/backends/{backend-name}/properties": {
"get": {
"description": "Returns properties of a backend.",
"operationId": "backend-properties.read",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{ "$ref": "" },
{
"example": "ibm_bromont",
"in": "path",
"name": "backend-name",
"required": true,
"schema": { "examples": ["ibm_bromont"], "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://www.qiskit.org/schemas/backend_props_schema.json",
"description": "OpenQuantum backend properties schema",
"version": "1.0.0",
"definitions": {
"gate": {
"properties": {
"gate": { "type": "string" },
"parameters": {
"items": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"qubits": { "items": { "type": "integer" }, "minItems": 1, "type": "array" }
},
"required": ["qubits", "gate", "parameters"],
"type": "object"
},
"general_parameters": {
"description": "General system parameters",
"items": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"nduv": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
}
},
"properties": {
"backend_name": { "description": "Backend name", "type": "string" },
"backend_version": {
"description": "Backend version in the form X.X.X",
"pattern": "[0-9]+.[0-9]+.[0-9]+$",
"type": "string"
},
"gates": {
"description": "System gate parameters",
"items": {
"properties": {
"gate": { "type": "string" },
"parameters": {
"items": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"qubits": {
"items": { "type": "integer" },
"minItems": 1,
"type": "array"
}
},
"required": ["qubits", "gate", "parameters"],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"general": {
"description": "General system parameters",
"items": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"last_update_date": {
"description": "Last date/time that a property was updated.",
"format": "date-time",
"type": "string"
},
"qubits": {
"description": "System qubit parameters",
"items": {
"items": {
"description": "Recorded parameter as a name-date-unit-value",
"properties": {
"date": { "format": "date-time", "type": "string" },
"name": { "type": "string" },
"unit": { "type": "string" },
"value": { "type": "number" }
},
"required": ["name", "date", "unit", "value"],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"backend_name",
"backend_version",
"last_update_date",
"qubits",
"gates",
"general"
],
"type": "object"
}
}
},
"description": "Returned when backend properties was retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when backend is not found."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get backend properties",
"tags": ["Backends"],
"x-ibm-events": {
"events": [{ "name": "quantum-computing.direct-access-backend-properties.read" }]
},
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-backend-properties.read" }]
}
}
},
"/v1/jobs": {
"get": {
"description": "Fetches a list of all jobs submitted by the current authenticated client, ordered by creation time in ascending order.",
"operationId": "jobs.read",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"jobs": {
"items": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"type": "string"
},
"created_time": {
"description": "Time when job was created.",
"format": "date-time",
"type": "string"
},
"end_time": {
"description": "Time when job reached a terminal status.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Unique ID for the Job (UUID V4)",
"type": "string"
},
"log_level": {
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"type": "string"
},
"reason_code": {
"description": "This field will be set to a numeric error code when the job has failed.",
"format": "int64",
"type": "integer"
},
"reason_message": {
"description": "Reason message explaining why the job is in a particular status. Ex: If a job has Failed, this field will have the error message.",
"type": "string"
},
"reason_solution": {
"description": "Next steps to take in case of failure.",
"type": "string"
},
"status": {
"description": "Current status of the job.",
"enum": ["Running", "Completed", "Cancelled", "Failed"],
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled.",
"format": "int64",
"type": "integer"
},
"usage": {
"description": "Job usage details.",
"additionalProperties": false,
"properties": {
"quantum_nanoseconds": {
"description": "Execution time on quantum device in nanoseconds.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"required": ["id", "program_id", "backend", "status", "created_time"],
"type": "object"
},
"type": ["array", "null"]
}
},
"required": ["jobs"],
"type": "object"
}
}
},
"description": "Returned when jobs were retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get jobs",
"tags": ["Jobs"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-job.list" }] },
"x-ibm-permissions": { "actions": [{ "name": "quantum-computing.direct-access-job.list" }] }
},
"post": {
"description": "Invoke a Qiskit Runtime primitive.",
"operationId": "job.create",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"Using S3 compatible storage": {
"value": {
"id": "6e32f594-189e-4bc5-89a2-3c21e1c7e75b",
"program_id": "estimator",
"backend": "ibm_bromont",
"timeout_secs": 10000,
"storage": {
"input": { "type": "s3_compatible", "presigned_url": "" },
"results": {
"type": "s3_compatible",
"presigned_url": ""
},
"logs": { "type": "s3_compatible", "presigned_url": "" }
}
}
}
},
"schema": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"id": {
"description": "Job identifier. Recommended to be UUID",
"maxLength": 36,
"minLength": 1,
"type": "string"
},
"log_level": {
"default": "warning",
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled. It is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job.",
"format": "int64",
"minimum": 1,
"type": "integer"
}
},
"required": ["id", "program_id", "backend", "timeout_secs", "storage"],
"type": "object"
}
}
},
"required": true
},
"responses": {
"204": { "description": "Returned when job was submitted successfully." },
"400": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when invalid input is received."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when the backend was not found"
},
"408": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when the request took too long to read."
},
"409": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when a duplicate job with same job ID was submitted."
},
"413": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when the request body is too large."
},
"422": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when validation of the request failed. The error message contains details about the specific validation error."
},
"423": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "The requested backend is reserved and jobs outside of the reservation cannot be run."
},
"429": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when per backend concurrent job limit has been reached. Try again later once existing jobs terminate and delete terminated jobs to submit more."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Run a job",
"tags": ["Jobs"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-job.create" }] },
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-job.create" }]
}
}
},
"/v1/jobs/{job-id}": {
"delete": {
"description": "Deletes a job if it has terminated.",
"operationId": "job.delete",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{ "in": "path", "name": "job-id", "required": true, "schema": { "type": "string" } }
],
"responses": {
"204": { "description": "Returned when job was deleted successfully." },
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when job is not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when a job has not yet terminated and has to be cancelled before it can be deleted."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Delete a job",
"tags": ["Jobs"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-job.delete" }] },
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-job.delete" }]
}
},
"get": {
"description": "Fetches a single job by its unique identifier for the current authenticated client.",
"operationId": "job.read",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{ "in": "path", "name": "job-id", "required": true, "schema": { "type": "string" } }
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"backend": {
"description": "Name of the backend",
"examples": ["ibm_rensselaer"],
"type": "string"
},
"created_time": {
"description": "Time when job was created.",
"format": "date-time",
"type": "string"
},
"end_time": {
"description": "Time when job reached a terminal status.",
"format": "date-time",
"type": "string"
},
"id": { "description": "Unique ID for the Job (UUID V4)", "type": "string" },
"log_level": {
"description": "Logging level of the program",
"enum": ["info", "debug", "warning", "error", "critical"],
"type": "string"
},
"program_id": {
"description": "ID of the program",
"examples": ["sampler"],
"type": "string"
},
"reason_code": {
"description": "This field will be set to a numeric error code when the job has failed.",
"format": "int64",
"type": "integer"
},
"reason_message": {
"description": "Reason message explaining why the job is in a particular status. Ex: If a job has Failed, this field will have the error message.",
"type": "string"
},
"reason_solution": {
"description": "Next steps to take in case of failure.",
"type": "string"
},
"status": {
"description": "Current status of the job.",
"enum": ["Running", "Completed", "Cancelled", "Failed"],
"type": "string"
},
"storage": {
"additionalProperties": false,
"properties": {
"input": {
"description": "Location from where input will be read. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"logs": {
"description": "Location for where job logs will be stored.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
},
"results": {
"description": "Location for where job results will be stored. Required for primitive programs.",
"additionalProperties": false,
"properties": {
"bucket_crn": {
"description": "Fully specified CRN for the target Cloud Object Storage bucket. bucket_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket"
],
"type": "string"
},
"object_name": {
"description": "Name/ID of the object in the IBM Cloud Object Storage bucket. object_name is required when type is ibmcloud_cos",
"type": "string"
},
"presigned_url": {
"description": "Presigned GET or PUT URLs to read job params or write results and logs to. presigned_url is required when type is s3_compatible",
"type": "string"
},
"region": {
"description": "region is required when type is ibmcloud_cos",
"examples": ["us-east"],
"pattern": "^[a-zA-Z-]+$",
"type": "string"
},
"region_type": {
"description": "Region, Cross-Region, or Single Data Center as defined by IBM Cloud Object Storage (https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). region_type is required when type is ibmcloud_cos",
"enum": ["regional", "cross-region", "single-site"],
"type": "string"
},
"runtime_instance_crn": {
"description": "Service CRN of the runtime instance that has access to the provided storage location. runtime_instance_crn is required when type is ibmcloud_cos",
"examples": [
"crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::"
],
"type": "string"
},
"type": { "enum": ["s3_compatible"], "type": "string" }
},
"required": ["type"],
"type": "object"
}
},
"type": "object"
},
"timeout_secs": {
"description": "Time (in seconds) after which job should time out and get cancelled.",
"format": "int64",
"type": "integer"
},
"usage": {
"description": "Job usage details.",
"additionalProperties": false,
"properties": {
"quantum_nanoseconds": {
"description": "Execution time on quantum device in nanoseconds.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"required": ["id", "program_id", "backend", "status", "created_time"],
"type": "object"
}
}
},
"description": "Job retrieved successfully."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "No job found for the provided ID belonging to the authenticated client."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Get Job by ID",
"tags": ["Jobs"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-job.read" }] },
"x-ibm-permissions": { "actions": [{ "name": "quantum-computing.direct-access-job.read" }] }
}
},
"/v1/jobs/{job-id}/cancel": {
"post": {
"description": "Cancels a job if it has not yet terminated.",
"operationId": "job.cancel",
"parameters": [
{ "$ref": "" },
{ "$ref": "" },
{
"description": "Service CRN of the Direct Access plan instance.",
"example": "crn:v1:bluemix:public:resource:global:a/1234:abc1234:resource:my-resource",
"in": "header",
"name": "service-crn",
"schema": { "type": "string" }
},
{
"description": "Date based API version. The list of supported versions can be obtained using /versions API and the latest version can be obtained using /version API. If this header is omitted, the API defaults to the latest available version. The format for the date version is YYYY-MM-DD (YYYYMMDD format is also supported but deprecated).",
"example": "2025-08-15",
"in": "header",
"name": "IBM-API-Version",
"schema": { "type": "string" }
},
{ "in": "path", "name": "job-id", "required": true, "schema": { "type": "string" } }
],
"responses": {
"204": { "description": "Returned when job cancel request was submitted successfully." },
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
},
"404": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when job is not found."
},
"409": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when a job has already terminated and cannot be cancelled."
},
"500": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when an internal server error occurs."
}
},
"security": [{ "IAMBearerTokenAuth": [] }],
"summary": "Cancel a job",
"tags": ["Jobs"],
"x-ibm-events": { "events": [{ "name": "quantum-computing.direct-access-job.cancel" }] },
"x-ibm-permissions": {
"actions": [{ "name": "quantum-computing.direct-access-job.cancel" }]
}
}
},
"/version": {
"get": {
"description": "Returns the latest supported version.",
"operationId": "version.read",
"parameters": [{ "$ref": "" }],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"version": { "examples": ["{\"version\": \"2025-08-15\"}"], "type": "string" }
},
"required": ["version"],
"type": "object"
}
}
},
"description": "Returns the latest supported version."
},
"500": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when API is not healthy."
}
},
"summary": "Get latest API version",
"tags": ["Versions"]
}
},
"/versions": {
"get": {
"operationId": "versions.list",
"parameters": [{ "$ref": "" }],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"versions": {
"examples": [["{ \"versions\": [\"2025-08-15\"]}"]],
"items": { "type": "string" },
"type": ["array", "null"]
}
},
"required": ["versions"],
"type": "object"
}
}
},
"description": "Supported API versions."
},
"401": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"correlation_id": {
"description": "A unique identifier for this error occurrence, typically used for tracking error occurrence in direct-access service logs.",
"type": "string"
},
"errors": {
"description": "A list of detailed error objects. Each error entry provides granular context (for example, validation failures, missing fields, or service-specific issues).",
"items": {
"additionalProperties": false,
"properties": {
"code": {
"description": "Error code which can be used in client code. Solutions for various error codes are available here https://docs.quantum.ibm.com/errors",
"type": "string"
},
"location": {
"description": "(Deprecated) Location is a path-like string indicating where the error occurred. Prefer using the 'target' field instead. It typically begins with 'path', 'query', 'header', or 'body'. Example: 'body.items[3].tags' or 'path.thing-id'.",
"type": "string"
},
"message": {
"description": "Message is a human-readable explanation of the error.",
"type": "string"
},
"more_info": {
"description": "Link to documentation on how to handle errors.",
"type": "string"
},
"target": {
"description": "Target is a path-like string indicating where the error occurred.",
"additionalProperties": false,
"properties": {
"name": {
"description": "This field MUST contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header.",
"type": "string"
},
"type": {
"description": "This field MUST contain field, parameter, or header.",
"enum": ["field", "parameter", "header"],
"type": "string"
}
},
"type": "object"
},
"value": {
"description": "Value is the value at the given location, echoed back to the client to help with debugging. This can be useful for e.g. validating that the client didn't send extra whitespace or help when the client did not log an outgoing request."
}
},
"required": ["message"],
"type": "object"
},
"type": ["array", "null"]
},
"status_code": {
"description": "The HTTP status code of the error response.",
"format": "int64",
"type": "integer"
},
"title": {
"description": "A short, human-readable summary of the error. May be omitted when not applicable.",
"type": "string"
},
"trace": {
"description": "A unique identifier used to group request events across distributed systems. Ensures traceability across services",
"type": "string"
}
},
"required": ["status_code", "trace", "errors"],
"type": "object"
}
}
},
"description": "Returned when authentication failed."
}
},
"summary": "Get list of supported API versions.",
"tags": ["Versions"]
}
}
},
"tags": [{ "name": "Versions" }, { "name": "Backends" }, { "name": "Jobs" }, { "name": "Leases" }]
}