Fastfold Docs
Workflows

Workflows Overview

Endpoint map for workflow creation, graph configuration, execution, status, logs, and task results.

This page gives a single endpoint map for the Workflows API and links to each operation page.

Authentication

Use your Fastfold API key:

Authorization: Bearer <YOUR_API_KEY>

Endpoint map

The workflow endpoints documented below are sourced from openapi/workflows.yaml.

MethodPathPurposeDocs
POST/v1/workflowsCreate a workflow run (evolla_v1, calvados_openmm_v1, boltzgen_v1)Create Workflow Run
GET/v1/workflows/{workflow_id}Fetch workflow run detailsGet Workflow Run
PATCH/v1/workflows/{workflow_id}/publicToggle public visibilityUpdate Workflow Public
GET/v1/workflows/public/{workflow_id}Read a public workflow runGet Public Workflow Run
POST/v1/workflows/graph/addCreate graph shell (used by boltzgen_v1)Create Workflow Graph
GET/v1/workflows/{workflow_id}/workflow.ymlGet serialized workflow YAMLGet Workflow YAML
POST/v1/workflows/{workflow_id}/workflow.ymlReplace graph from workflow YAMLSet Workflow YAML
POST/v1/workflows/executeExecute a workflow by IDExecute Workflow
GET/v1/workflows/status/{workflow_id}Fetch workflow + task statusesGet Workflow Status
GET/v1/workflows/logs/{workflow_id}Fetch workflow logsGet Workflow Logs
GET/v1/workflows/task-results/{workflow_id}Fetch parsed task outputs/artifactsGet Workflow Task Results
GET/v1/workflows/evolla/linked-previewsList linked Evolla previews for a fold sourceGet Evolla Linked Previews
GET/v1/workflows/evolla/linked-historyFetch linked Evolla history rowsGet Evolla Linked History
PATCH/v1/workflows/evolla/{workflow_id}/draft-questionUpdate initial question for DRAFT Evolla workflowUpdate Evolla Draft Question
GET/v1/workflows/openmm/input-from-fold-job/previewPreview resolved OpenMM fold inputsPreview OpenMM Input From Fold Job

Common call sequences

BoltzGen graph workflow

  1. POST /v1/workflows/graph/add
  2. POST /v1/workflows/{workflow_id}/workflow.yml
  3. POST /v1/workflows/execute
  4. GET /v1/workflows/status/{workflow_id} (poll)
  5. GET /v1/workflows/task-results/{workflow_id}
  6. Optional: GET /v1/workflows/logs/{workflow_id}

Evolla/OpenMM workflow

  1. POST /v1/workflows
  2. POST /v1/workflows/execute (when required by workflow type)
  3. GET /v1/workflows/status/{workflow_id} (poll)
  4. GET /v1/workflows/task-results/{workflow_id}

Last updated on

On this page