Skip to main content
IBM Quantum Platform

Tarefas


Execute uma tarefa

Invocar uma primitiva Qiskit Runtime. Observe o ID do trabalho retornado. Você o usará para verificar o status do trabalho e revisar os resultados. Essa solicitação tem uma taxa limitada a 5 trabalhos por minuto por usuário.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.create

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.create

Entrada

Parâmetros do corpo
Nome, Tipo
Descrição
program_id
string

ID do programa a ser executado

backend
string

Nome que identifica o backend no qual o programa será executado.

runtime
string

Nome e tag da imagem a ser usada ao executar um programa (somente para usuários do canal IBM Quantum ). Deve seguir o padrão "name:tag".

tags
string[]

Lista de tags de trabalho ou de programa

log_level
string

Nível de registro do programa

Valores possíveis: criticalerrorwarninginfodebug
cost
integer

Custo do trabalho como o tempo estimado que ele deve levar para ser concluído (em segundos). Não deve exceder o custo do programa. Se o valor fornecido exceder o máximo, ele será limitado a esse valor.

Valor mínimo: 0
Valor máximo: 10800
session_id
string

Identificador da sessão da qual o trabalho faz parte

calibration_id
string

A ID da calibração usada para o trabalho

params
one of
SamplerV2 entrada
object

A entrada para uma chamada à API SamplerV2

EstimatorV2 entrada
object

A entrada para uma chamada à API EstimatorV2

NoiseLearner entrada
object

A entrada para uma chamada à API NoiseLearner

Entrada do executor v0.1
object

Um modelo que descreve as entradas do programa Executor.

Entrada do executor v0.2
object

Um modelo que descreve as entradas do programa Executor.

Executor v1.0 ParamsModel
object

Um modelo que descreve as entradas do programa Executor.

Executor v1.1 ParamsModel
object

Um modelo que descreve as entradas do programa Executor.

NoiseLearnerV3 v0.1 entrada
object

Um modelo que descreve as entradas do programa “Noise Learner” V3.

NoiseLearnerV3 v0.2 entrada
object

Um modelo que descreve as entradas do programa “Noise Learner” V3.

NoiseLearnerV3 v0.3 ParamsModel
object

Um modelo que descreve as entradas do programa “Noise Learner” V3.

private
boolean

Quando definido como true, os parâmetros de entrada não são retornados e os resultados só podem ser lidos uma vez. Após a conclusão do trabalho, os parâmetros de entrada são excluídos do serviço. Depois que os resultados são lidos, eles são excluídos do serviço. Quando definido como false, os parâmetros de entrada e os resultados seguem o comportamento de retenção padrão da API. Somente será retornado na resposta se o valor for verdadeiro; caso contrário, será omitido.

Amostras de código
POST
/v1/jobs

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Ok
400Solicitação inválida
401Desautorizado
403Proibido
404Não encontrado
409O uso excede o limite da instância
Respostas
{
  "id": "c5dge2d3rn7breq27i9g",
  "backend": "ibm_backend",
  "private": true
}

Listar tarefas

Liste os trabalhos do programa quantum que você executou.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.read

Entrada

Parâmetros de consulta
Nome, Tipo
Descrição
limit
integer

Número de resultados a serem retornados por vez. Se o valor fornecido estiver fora do intervalo viável, não ocorrerá nenhum erro e o valor padrão será usado em seu lugar.

Valor Padrão: 200
Valor mínimo: 1
Valor máximo: 200
offset
integer

Número de resultados a serem compensados ao recuperar a lista de trabalhos. Se o valor fornecido estiver fora do intervalo viável, não ocorrerá nenhum erro e o valor padrão será usado em seu lugar.

Valor Padrão: 0
Valor mínimo: 0
Valor máximo: 2147483647
pending
boolean

Retorna trabalhos "Em fila" e "Em execução" se for verdadeiro. Retorna os trabalhos "Completed" (Concluído), "Cancelled" (Cancelado) e "Failed" (Falha) se for falso.

program
string

ID do programa para filtrar trabalhos

backend
string

Backend para filtrar trabalhos

created_after
string

Trabalho criado após o filtro

created_before
string

Trabalho criado antes do filtro

sort
string

Classificar trabalhos por hora de criação ASC ou DESC (padrão)

tags
string[]

Tags para filtrar trabalhos

session_id
string

ID da sessão para filtrar trabalhos

exclude_params
boolean

Excluir parâmetros de trabalho da resposta

Valor Padrão: true
Amostras de código
GET
/v1/jobs

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Ok
400Solicitação inválida
401Desautorizado
403Proibido
404Não encontrado
Respostas
{
  "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
}

Listar detalhes do trabalho

Lista os detalhes sobre o trabalho do programa quântico especificado.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Identificador de um trabalho existente

Parâmetros de consulta
Nome, Tipo
Descrição
exclude_params
boolean

Excluir parâmetros de trabalho da resposta

Valor Padrão: false
Amostras de código
GET
/v1/jobs/{id}

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Ok
401Desautorizado
403Proibido
404Não encontrado
Respostas
{
  "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"
}

Exclua uma tarefa

Exclui o trabalho especificado e seus dados associados. O trabalho deve estar em um estado terminal.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.delete

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.delete

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Identificador de um trabalho existente

Amostras de código
DELETE
/v1/jobs/{id}

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Ok
400Solicitação inválida
401Desautorizado
403Proibido
404Não encontrado
500Erro interno ao excluir o trabalho
Respostas
Ok

Cancelar uma Tarefa

Cancela o trabalho especificado.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.cancel

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.cancel

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Um ID de trabalho

Amostras de código
POST
/v1/jobs/{id}/cancel

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Ok
400Solicitação de cancelamento incorreta
401Desautorizado
403Proibido
404Não encontrado
409O trabalho está em status não cancelável.
500Erro interno ao cancelar o trabalho
Respostas
Ok

Listar registros de trabalho

Lista todos os logs de trabalho para o trabalho especificado.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Um ID de trabalho

Amostras de código
GET
/v1/jobs/{id}/logs

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Retorna os registros de trabalho.
401Desautorizado
403Proibido
404Não localizadas
Respostas
Retorna os registros de trabalho.

Obter métricas de trabalho

Obtém métricas do trabalho especificado

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Um ID de trabalho

Amostras de código
GET
/v1/jobs/{id}/metrics

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Ok
401Desautorizado
403Proibido
404Não encontrado
Respostas
{
  "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,
    "status": "complete"
  },
  "circuits_execution_time_ns": 20000000,
  "qiskit_version": "2.3.0"
}

Listar resultados do trabalho

Retorna o resultado final desse trabalho.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Um ID de trabalho

Amostras de código
GET
/v1/jobs/{id}/results

Se sua instância estiver na região eu-de, use este 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: 2026-04-15'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Retorna o resultado final do trabalho.
204O resultado final do trabalho não foi encontrado.
400Solicitação inválida
401Desautorizado
403Proibido
404Não encontrado
Respostas
{
  "schema_version": "v0.1",
  "data": [
    {
      "results": {},
      "metadata": null
    }
  ],
  "metadata": {
    "chunk_timing": [
      {
        "start": "example",
        "stop": "example",
        "parts": [
          {
            "idx_item": 1,
            "size": 1
          }
        ]
      }
    ]
  }
}

Substituir etiquetas de trabalho

Substituir etiquetas de trabalho

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.job.update

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.job.update

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

Um ID de trabalho

Parâmetros do corpo
Nome, Tipo
Descrição
tags
Necessário
string[]

Lista de tags de trabalho ou de programa

Amostras de código
PUT
/v1/jobs/{id}/tags

Se sua instância estiver na região eu-de, use este 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: 2026-04-15' \
  -H 'Content-Type: application/json' \
  -d '{"tags":["example"]}'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Ok
401Desautorizado
403Proibido
404Não encontrado
Respostas
Ok
Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.