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.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.create

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.create

入力

本文パラメーター
名前、タイプ
説明
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

使用可能な値: 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.

最小値:: 0
最大値:: 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.

コード・サンプル
POST
/v1/jobs

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Usage exceeds instance limit
応答
{
  "id": "c5dge2d3rn7breq27i9g",
  "backend": "ibm_backend",
  "private": true
}

List jobs

List the quantum program jobs you have run.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.read

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.read

入力

照会パラメーター
名前、タイプ
説明
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.

デフォルト値: 200
最小値:: 1
最大値:: 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.

デフォルト値: 0
最小値:: 0
最大値:: 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

デフォルト値: true
コード・サンプル
GET
/v1/jobs

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
応答
{
  "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.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.read

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.read

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

Identifier of an existing job

照会パラメーター
名前、タイプ
説明
exclude_params
boolean

Exclude job params from the response

デフォルト値: false
コード・サンプル
GET
/v1/jobs/{id}

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200OK
401Unauthorized
403Forbidden
404Not Found
応答
{
  "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.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.delete

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.delete

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

Identifier of an existing job

コード・サンプル
DELETE
/v1/jobs/{id}

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
204OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
500Internal error deleting job
応答
OK

Cancel a job

Cancels the specified job.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.cancel

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.cancel

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

A job ID

コード・サンプル
POST
/v1/jobs/{id}/cancel

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
204OK
400Bad cancel request
401Unauthorized
403Forbidden
404Not Found
409Job is in non cancellable status.
500Internal error cancelling job
応答
OK

List job logs

List all job logs for the specified job.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.read

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.read

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

A job ID

コード・サンプル
GET
/v1/jobs/{id}/logs

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200Returns job logs.
401Unauthorized
403Forbidden
404Not found
応答
Returns job logs.

Get job metrics

Gets metrics of specified job

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.read

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.read

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

A job ID

コード・サンプル
GET
/v1/jobs/{id}/metrics

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200OK
401Unauthorized
403Forbidden
404Not Found
応答
{
  "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.

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.read

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.read

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

A job ID

コード・サンプル
GET
/v1/jobs/{id}/results

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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'

出力

HTTP応答状況コード
状況コード
説明
200Returns the job's final result.
204Job's final result not found.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
応答
{
  "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

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

  • quantum-computing.job.update

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

  • quantum-computing.job.update

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

A job ID

本文パラメーター
名前、タイプ
説明
tags
必須
string[]

List of job or program tags

コード・サンプル
PUT
/v1/jobs/{id}/tags

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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"]}'

出力

HTTP応答状況コード
状況コード
説明
204OK
401Unauthorized
403Forbidden
404Not Found
応答
OK
このページは役に立ちましたか?
バグや誤字の報告、またはコンテンツの要求はGitHubで行ってください。