Skip to main content
IBM Quantum Platform

Jobs

Run a job

Invoke a Qiskit Runtime primitive. Note the returned job ID. You will use it to check the job's status and review results. This request is rate limited to 5 jobs per minute per user.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.create

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.create

Eingabe

Hauptteilparameter
Name, Typ
Beschreibung
program_id
string

ID of the program to be executed

backend
string

Name that identifies the backend on which to run the program.

runtime
string

Name and tag of the image to use when running a program (IBM Quantum channel users only). Should follow the pattern "name:tag".

tags
string[]

List of job or program tags

log_level
string

Logging level of the program

Gültige Werte: criticalerrorwarninginfodebug
cost
integer

Cost of the job as the estimated time it should take to complete (in seconds). Should not exceed the cost of the program. If the provided value exceeds the maximum, it will be capped at that value.

Mindestwert: 0
Maximalwert: 10800
session_id
string

Identifier of the session that the job is a part of

calibration_id
string

The ID of the calibration used for the job

params
one of
SamplerV2 input
object

The input for an SamplerV2 API call

EstimatorV2 input
object

The input for an EstimatorV2 API call

NoiseLearner input
object

The input for a NoiseLearner API call

Executor v0.1 input
object

A model describing the Executor program inputs.

Executor v0.2 input
object

A model describing the Executor program inputs.

Executor v1.0 ParamsModel
object

A model describing the Executor program inputs.

Executor v1.1 ParamsModel
object

A model describing the Executor program inputs.

Executor v2.0 ParamsModel
object

A model describing the Executor program inputs.

NoiseLearnerV3 v0.1 input
object

A model describing the Noise Learner V3 program inputs.

NoiseLearnerV3 v0.2 input
object

A model describing the Noise Learner V3 program inputs.

NoiseLearnerV3 v0.3 ParamsModel
object

A model describing the Noise Learner V3 program inputs.

private
boolean

When set to true, input parameters are not returned, and the results can only be read once. After the job is completed, input parameters are deleted from the service. After the results are read, they are deleted from the service. When set to false, the input parameters and results follow the standard retention behavior of the API. Only returned in the response if the value is true, otherwise it is omitted.

Codebeispiele
POST
/v1/jobs

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs

curl -X POST \
  'https://quantum.cloud.ibm.com/api/v1/jobs' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Usage exceeds instance limit
Antworten
{
  "id": "c5dge2d3rn7breq27i9g",
  "backend": "ibm_backend",
  "private": true
}

List jobs

List the quantum program jobs you have run.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.read

Eingabe

Abfrageparameter
Name, Typ
Beschreibung
limit
integer

Number of results to return at a time. If the provided value is outside of the viable range, no error occurs and the default value is used instead.

Standardwert: 200
Mindestwert: 1
Maximalwert: 200
offset
integer

Number of results to offset when retrieving the list of jobs. If the provided value is outside of the viable range, no error occurs and the default value is used instead.

Standardwert: 0
Mindestwert: 0
Maximalwert: 2147483647
pending
boolean

Returns 'Queued' and 'Running' jobs if true. Returns 'Completed', 'Cancelled', and 'Failed' jobs if false.

program
string

Program ID to filter jobs

backend
string

Backend to filter jobs

created_after
string

Job created after filter

created_before
string

Job created before filter

sort
string

Sort jobs by created time ASC or DESC (default)

tags
string[]

Tags to filter jobs

session_id
string

Session ID to filter jobs

exclude_params
boolean

Exclude job params from the response

Standardwert: true
Codebeispiele
GET
/v1/jobs

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/jobs' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
Antworten
{
  "jobs": [
    {
      "id": "c5dge2d3rn7breq27i9g",
      "backend": "ibmq_qasm_simulator",
      "cost": 0,
      "state": {
        "status": "Completed",
        "reason": ""
      },
      "status": "Completed",
      "params": {
        "iterations": 3
      },
      "program": {
        "id": "myprogram-abcdef12345"
      },
      "created": "2021-10-04T13:52:09.456851Z",
      "runtime": "ntc-provider-primitives:latest",
      "tags": [
        "tag1",
        "tag2",
        "tag3",
        "tag4"
      ],
      "session_id": "c5dge2d3rn7breq27i9g",
      "usage": {
        "qpu_charge_time_seconds": 20,
        "status": "complete"
      },
      "private": true,
      "estimated_running_time_seconds": 30.5,
      "calibration_id": "fez-ac-tls-test"
    },
    {
      "id": "c2gfe1m3ln7breq27i6e",
      "backend": "ibmq_qasm_simulator",
      "cost": 0,
      "state": {
        "status": "Completed",
        "reason": ""
      },
      "status": "Completed",
      "params": {
        "iterations": 3
      },
      "program": {
        "id": "myprogram-abcdef12345"
      },
      "created": "2021-10-05T13:52:09.456851Z",
      "runtime": "ntc-provider-primitives:latest",
      "tags": [
        "tag1",
        "tag2",
        "tag3",
        "tag4"
      ],
      "session_id": "c1mre2f3pn9breq18i4g"
    }
  ],
  "count": 2,
  "limit": 2,
  "offset": 0
}

List job details

List the details about the specified quantum program job.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.read

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

Identifier of an existing job

Abfrageparameter
Name, Typ
Beschreibung
exclude_params
boolean

Exclude job params from the response

Standardwert: false
Codebeispiele
GET
/v1/jobs/{id}

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200OK
401Unauthorized
403Forbidden
404Not Found
Antworten
{
  "id": "c5dge2d3rn7breq27i9g",
  "backend": "ibmq_qasm_simulator",
  "cost": 0,
  "state": {
    "status": "Completed",
    "reason": ""
  },
  "status": "Completed",
  "params": {
    "iterations": 3
  },
  "program": {
    "id": "myprogram-abcdef12345"
  },
  "created": "2021-10-04T13:52:09.456851Z",
  "runtime": "ntc-provider-primitives:latest",
  "tags": [
    "tag1",
    "tag2",
    "tag3",
    "tag4"
  ],
  "session_id": "c5dge2d3rn7breq27i9g",
  "private": true,
  "estimated_running_time_seconds": 30.5,
  "calibration_id": "fez-ac-tls-test"
}

Delete a job

Delete the specified job and its associated data. Job must be in a terminal state.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.delete

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.delete

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

Identifier of an existing job

Codebeispiele
DELETE
/v1/jobs/{id}

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}

curl -X DELETE \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
500Internal error deleting job
Antworten
OK

Cancel a job

Cancels the specified job.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.cancel

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.cancel

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

A job ID

Codebeispiele
POST
/v1/jobs/{id}/cancel

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}/cancel

curl -X POST \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}/cancel' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204OK
400Bad cancel request
401Unauthorized
403Forbidden
404Not Found
409Job is in non cancellable status.
500Internal error cancelling job
Antworten
OK

List job logs

List all job logs for the specified job.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.read

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

A job ID

Codebeispiele
GET
/v1/jobs/{id}/logs

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}/logs

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}/logs' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200Returns job logs.
401Unauthorized
403Forbidden
404Not found
Antworten
Returns job logs.

Get job metrics

Gets metrics of specified job

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.read

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

A job ID

Codebeispiele
GET
/v1/jobs/{id}/metrics

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}/metrics

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}/metrics' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200OK
401Unauthorized
403Forbidden
404Not Found
Antworten
{
  "timestamps": {
    "created": "2026-03-06T14:02:11Z",
    "running": "2026-03-06T14:02:18Z",
    "finished": "2026-03-06T14:05:47Z"
  },
  "usage": {
    "qpu_charge_time_seconds": 20,
    "value": 0.3333,
    "unit": "resource_units",
    "status": "complete",
    "details": [
      {
        "value": 0.3333,
        "unit": "resource_units",
        "metric": {
          "id": "b3b57f1e-1c2a-4b0a-9c3e-1f8f2a6d5e4a",
          "value": 20
        }
      }
    ]
  },
  "circuits_execution_time_ns": 20000000,
  "qiskit_version": "2.3.0"
}

List job results

Return the final result from this job.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.read

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

A job ID

Codebeispiele
GET
/v1/jobs/{id}/results

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}/results

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}/results' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200Returns the job's final result.
204Job's final result not found.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
Antworten
{
  "schema_version": "v0.1",
  "data": [
    {
      "results": {},
      "metadata": null
    }
  ],
  "metadata": {
    "chunk_timing": [
      {
        "start": "example",
        "stop": "example",
        "parts": [
          {
            "idx_item": 1,
            "size": 1
          }
        ]
      }
    ]
  }
}

Replace job tags

Replace job tags

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.job.update

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.job.update

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

A job ID

Hauptteilparameter
Name, Typ
Beschreibung
tags
Erforderlich
string[]

List of job or program tags

Codebeispiele
PUT
/v1/jobs/{id}/tags

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen Link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/jobs/{id}/tags

curl -X PUT \
  'https://quantum.cloud.ibm.com/api/v1/jobs/{id}/tags' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01' \
  -H 'Content-Type: application/json' \
  -d '{"tags":["example"]}'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204OK
401Unauthorized
403Forbidden
404Not Found
Antworten
OK
War diese Seite hilfreich?
Melden Sie auf GitHub einen Fehler, einen Tippfehler oder fordern Sie Inhalte an.