Boltz Check Status

作者 boltz-biobeafb3c16236无许可证5 个星标收录于 2026年10月8日更新于 2026年10月8日仓库4周前更新

Boltz job status and result recovery. Use when listing jobs, checking progress, resuming downloads, recovering results, or downloading an existing job ID. Not for starting new jobs.

仅含说明DevOps & Cloud
AI 生成的概览

检查 Boltz 作业状态、列出近期作业,并恢复或下载已有作业 ID 的结果。

功能
该技能指导智能体使用 boltz-api 命令行工具检查和恢复 Boltz 计算作业。它涵盖四种模式:读取本地下载器状态、列出六类资源中的近期作业、按 ID 检索单个作业,以及恢复或下载已有作业的结果。它会输出结构化状态数据供展示,并将恢复的产物写入指定的输出根目录。它明确不负责编写请求负载,也不启动新作业。
适用场景
当用户想要列出 Boltz 作业、查看进度、从中断的会话中恢复结果,或下载已有作业 ID 的结果时使用。它不适用于启动新作业。
运行要求
需要 PATH 中存在 boltz-api 命令行工具,凭据缺失或过期时需通过 boltz-api auth login 进行身份验证,并需要访问 Boltz API 的网络连接。该技能不附带脚本,仅为说明文档,另含两份参考文档。某些运行环境可能需要沙箱提权,以便安装命令行工具、进行浏览器登录、存储凭据、使用临时文件或访问 API。

Workflow

If boltz-api is missing from PATH, use boltz-cli-setup for install/update guidance before retrying. If a command reports missing or expired authentication, use boltz-cli-setup to start boltz-api auth login --device-code before retrying; do not ask permission first. If the agent host sandbox blocks boltz-api install/auth/API calls, use boltz-cli-setup to request the host sandbox bypass/escalation needed for user-wide CLI install, browser login, credential storage, temp files, or API access before retrying.

Use this skill to recover state across sessions and to inspect or download results for prior Boltz jobs. No payload authoring — this skill only calls list / retrieve / download-results / download-status.

Use four modes:

  1. Local progress: if the user knows the run name / run dir, prefer download-status before remote API calls.
  2. List recent jobs: enumerate all six resources, merge, and sort by created_at descending.
  3. Retrieve one job: use the job ID prefix when known; otherwise probe resources until one succeeds.
  4. Resume/download results: run download-results with the original run name when possible. Never run start again to resume.

ADME jobs use the prefix adme_pred_* and show up in Modes 1-2 (list / retrieve) like the others. ADME has no download-results/archive step, so Modes 3-4 don't apply — recover its scores by re-running retrieve (read output.molecules[]) or from the local run.json.

Read references/resume.md [blocked] before recovering a dropped session, mapping job ID prefixes, or choosing a run name for download-results. Read references/api.md [blocked] for per-resource list columns, retrieve fields, and result semantics.

Command Pattern

bash
# Replace placeholders with concrete absolute paths before running.
# Local helper: inspect local checkpoint state without API calls.boltz-api --format json download-status \  --name "<run-name>" \  --root-dir "/absolute/path/boltz-experiments"
# Mode 1: list recent jobs across all 6 resources.# Note: the CLI emits one JSON object per record (streamed, no {data:[]} wrapper).# --limit is per-page and the CLI auto-paginates, so cap each explicit command with head.boltz-api predictions:structure-and-binding list --limit 20 --format jsonl | head -20boltz-api predictions:adme list --limit 20 --format jsonl | head -20boltz-api small-molecule:library-screen list --limit 20 --format jsonl | head -20boltz-api small-molecule:design list --limit 20 --format jsonl | head -20boltz-api protein:library-screen list --limit 20 --format jsonl | head -20boltz-api protein:design list --limit 20 --format jsonl | head -20
# Mode 2: retrieve by ID. Pick the resource from the ID prefix in the workflow# notes above. If the prefix is unknown, run these one at a time until one succeeds.boltz-api predictions:structure-and-binding retrieve --id "<job-id>" --format jsonboltz-api predictions:adme retrieve --id "<job-id>" --format jsonboltz-api small-molecule:library-screen retrieve --id "<job-id>" --format jsonboltz-api small-molecule:design retrieve --id "<job-id>" --format jsonboltz-api protein:library-screen retrieve --id "<job-id>" --format jsonboltz-api protein:design retrieve --id "<job-id>" --format json
# Mode 3: resume download. Launch it through the runtime's long-running/non-blocking# command facility (consult boltz-cli-setup if unsure).boltz-api download-results \  --id "<job-id>" --name "<run-name>" \  --root-dir "/absolute/path/boltz-experiments" \  --poll-interval-seconds 30

Always Do This

  • If the user has a run name / slug or run dir and only wants local downloader state, prefer download-status before retrieve.
  • Use an absolute output root and keep passing it through --root-dir. Do not cd into the run directory; that makes later relative paths point at the run directory instead of the user's workspace.
  • On an unfamiliar job ID, run Mode 2 (retrieve) before Mode 3 (download) so you capture idempotency_key.
  • Prefer the original run-name slug over the job ID as --name — it resumes into the existing dir with cursor.
  • In permission-gated runtimes, keep each Boltz call as a top-level command that starts with boltz-api. Prefer running the six list / retrieve commands explicitly over generating them from a shell loop; a fixed | head -20 cap is okay when listing to avoid runaway streamed output.
  • Run download-results through the runtime's long-running or non-blocking command facility, using the mechanism the runtime documents rather than tool arguments you assume exist. Do not detach it with shell & or nohup unless the runtime documents shell backgrounding as its supported mode; some tool runners reap shell-backgrounded children before .boltz-run.json is written. If unsure how this runtime handles long-running commands, consult boltz-cli-setup.
  • After the download starts, do not manually wait on it or run ad hoc polling loops. If the runtime can schedule follow-up checks (a heartbeat, scheduled task, or reminder), schedule one that runs download-status periodically, posts only material status changes or terminal completion/failure, and stops once terminal. If it cannot, do not claim an automatic next check; report the job ID, run name, output directory, and the command needed to check download-status.
  • download-results now emits machine-readable JSONL progress on stderr by default. Add --progress-format text --verbose only when you explicitly want human-readable logs.
  • Prefer download-status for local checkpoint state. Use it for any scheduled follow-up, and poll a saved session handle only for interactive, user-requested progress checks. Don't loop retrieve unless the user wants fresh remote status.
  • If retrieve surfaces only {"code":"VALIDATION_ERROR","message":"Request validation failed"} with no details, that's expected for predictions:structure-and-binding failures — other endpoints include field paths.
  • Never run start again on a failed or interrupted job. Fix the payload and submit with a new idempotency-key, or just resume with download-results.

Escape Hatch

  • Python SDK reference (per-resource list / retrieve methods): https://api.boltz.bio/docs/api/python
  • CLI flag names: boltz-api <resource> list --help, boltz-api <resource> retrieve --help, boltz-api download-results --help, boltz-api download-status --help

Outputs

  • Local helper / Mode 1 / Mode 2 print structured data to stdout; present as a table.
  • Mode 3 writes recovered artifacts under <output-root>/<run-name>/ — same layout as a fresh run. Read references/resume.md [blocked] for resume behavior.

来源与署名

来源:boltz-bio/boltz-api-skills位于plugins/boltz/skills/boltz-check-status提交beafb3c

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架