Fastfold Docs

Overview

Overview of SDK recipes organized by fold, OpenMM, OpenMMDL, Evolla, BoltzGen, and report use case.

The Fastfold SDK is the official Python client for submitting fold jobs, running workflows, uploading supporting files, and reading results from Fastfold programmatically. Use it in notebooks, scripts, services, and CI when you want a higher-level Python interface over the Fastfold API.

This section also covers the companion CLI, which exposes the same platform capabilities in a shell-friendly form for payload files, automation, and quick inspection from the terminal.

Start with Install for package installation, authentication, and base configuration. Then use the pages in this section by task:

  • Fold for fold jobs, typed sequence payloads, YAML submit, result metrics, and common model patterns
  • CLI for shell-oriented commands and payload-file workflows
  • OpenMM, OpenMMDL, Evolla, and BoltzGen for workflow-specific helpers
  • Workflows for generic workflow endpoints and direct workflow.yml control
  • Webhooks for webhook-enabled submit payloads
  • Report Sharing for Slack report delivery

The SDK surface is organized around a few main entry points:

  • client.fold and client.jobs for fold submission, raw payloads, YAML submit, status, and results
  • client.workflows for generic workflow creation, execution, task results, and YAML endpoints
  • client.library for uploads and file references
  • client.openmm, client.openmmdl, client.evolla, and client.boltzgen for higher-level workflow helpers
  • client.reports for markdown report sharing

If you need a field the SDK does not model yet, check the .raw payload first before dropping to direct HTTP. For webhook configuration endpoints and outgoing event schema, use the webhook reference pages under /webhooks/overview.

Last updated on