# Boltz API Docs

Boltz API docs for structure prediction, molecular design, and library screening.

## Docs

- [Run](/docs/api/cli/resources/predictions/subresources/adme/methods/run/index.md): Custom CLI workflow command for `boltz-api predictions:adme run`.
- [Run](/docs/api/cli/resources/predictions/subresources/structure_and_binding/methods/run/index.md): Custom CLI workflow command for `boltz-api predictions:structure-and-binding run`.
- [Run](/docs/api/cli/resources/protein/subresources/design/methods/run/index.md): Custom CLI workflow command for `boltz-api protein:design run`.
- [Run](/docs/api/cli/resources/protein/subresources/library_screen/methods/run/index.md): Custom CLI workflow command for `boltz-api protein:library-screen run`.
- [Run](/docs/api/cli/resources/small_molecule/subresources/design/methods/run/index.md): Custom CLI workflow command for `boltz-api small-molecule:design run`.
- [Run](/docs/api/cli/resources/small_molecule/subresources/library_screen/methods/run/index.md): Custom CLI workflow command for `boltz-api small-molecule:library-screen run`.
- [Run](/docs/api/python/resources/predictions/subresources/adme/methods/run/index.md): Custom Python SDK workflow method for `client.predictions.adme.run`.
- [Run](/docs/api/python/resources/predictions/subresources/structure_and_binding/methods/run/index.md): Custom Python SDK workflow method for `client.predictions.structure_and_binding.run`.
- [Run](/docs/api/python/resources/protein/subresources/design/methods/run/index.md): Custom Python SDK workflow method for `client.protein.design.run`.
- [Run](/docs/api/python/resources/protein/subresources/library_screen/methods/run/index.md): Custom Python SDK workflow method for `client.protein.library_screen.run`.
- [Run](/docs/api/python/resources/small_molecule/subresources/design/methods/run/index.md): Custom Python SDK workflow method for `client.small_molecule.design.run`.
- [Run](/docs/api/python/resources/small_molecule/subresources/library_screen/methods/run/index.md): Custom Python SDK workflow method for `client.small_molecule.library_screen.run`.
- [Agent integrations](/docs/guides/agent-integrations/index.md): Use Boltz API from Claude Code, Codex, and other coding agents.
- [Authentication](/docs/guides/authentication/index.md): Choose between API keys, OAuth bearer tokens, and share-link access.
- [Core Concepts](/docs/guides/concepts/index.md): Key concepts for working with the Boltz API, covering entities, metrics, binding, file inputs, constraints, modifications, and bonds.
- [Costs](/docs/guides/costs/index.md): Estimate what a run will cost before you submit it, understand how billing works, and develop for free in test mode.
- [Data Retention](/docs/guides/data-retention/index.md): How the Boltz API handles data retention, workspace-level configuration, and eager deletion.
- [Errors & retries](/docs/guides/errors/index.md): Read API error responses, tell a failed run from a stopped one, handle rate limits, rely on automatic retries, and submit jobs idempotently.
- [Organizations & Workspaces](/docs/guides/organizations-and-workspaces/index.md): How organizations, workspaces, and API keys are structured in the Boltz API.
- [Pagination](/docs/guides/pagination/index.md): List endpoints are cursor-paginated; the SDK iterates across pages for you, or you can page manually.
- [Predict structure and binding](/docs/guides/predictions/index.md): Predict 3D structure coordinates, per-residue confidence scores, and binding metrics for an arbitrary biomolecular complex.
- [Design proteins](/docs/guides/protein-design/index.md): Generate binder, generic, or composite protein designs, migrate legacy callers safely, and understand the discriminated result shapes.
- [Screen protein libraries](/docs/guides/protein-library-screen/index.md): Score your own protein sequences against a target, fetch results as they arrive, and stop early if needed.
- [Redesign protein sequences](/docs/guides/protein-sequence-redesign/index.md): Redesign selected residues in a fixed single-CIF structure, with binder or generic chain assignments that cover the entire structure.
- [Share links](/docs/guides/share-links/index.md): Give collaborators read-only access to selected predictions and pipeline results.
- [Predict small molecule ADME](/docs/guides/small-molecule-adme/index.md): Predict Tier-1 ADME summary properties (lipophilicity, permeability, and solubility) for a batch of small molecules by SMILES.
- [Design small molecules](/docs/guides/small-molecule-design/index.md): Generate novel small molecules against a protein target, monitor progress, fetch scored results, and stop early if needed.
- [Screen small molecule libraries](/docs/guides/small-molecule-library-screen/index.md): Score your own small molecules against a protein target, fetch results as they arrive, and stop early if needed.
- [Test Environment](/docs/guides/test-environment/index.md): Use the test environment for integration testing and API exploration without GPU usage or billing.
- [Workspace spending limits](/docs/guides/workspace-spending-limits/index.md): Cap workspace spend and use lifetime limits to enforce subtenant credit allocations.
- [Introduction](/docs/index.md): Model and design biomolecules with the Boltz API.
- [Boltz API Supplemental Terms](/docs/legal/api-supplemental-terms/index.md)
- [Boltz API Terms of Service](/docs/legal/api-terms-of-service/index.md)
- [Privacy Policy](/docs/privacy/privacy-policy/index.md)

## API Reference

Links below point to language-neutral HTTP documentation. SDK-specific docs follow the same URL structure with the language inserted after the base path: `/api/{language}/resources/...`.

Available languages: http, typescript, python, go, cli

### [Predictions](/docs/api/resources/predictions/index.md)


- [Structure And Binding](/docs/api/resources/predictions/subresources/structure_and_binding/index.md)

  - [Start](/docs/api/resources/predictions/subresources/structure_and_binding/methods/start/index.md): Start a structure and binding prediction
  - [List](/docs/api/resources/predictions/subresources/structure_and_binding/methods/list/index.md): List structure and binding predictions
  - [Retrieve](/docs/api/resources/predictions/subresources/structure_and_binding/methods/retrieve/index.md): Retrieve a structure and binding prediction
  - [Delete Data](/docs/api/resources/predictions/subresources/structure_and_binding/methods/delete_data/index.md): Delete prediction data
  - [Estimate Cost](/docs/api/resources/predictions/subresources/structure_and_binding/methods/estimate_cost/index.md): Estimate cost for a structure and binding prediction


- [Adme](/docs/api/resources/predictions/subresources/adme/index.md)

  - [Start](/docs/api/resources/predictions/subresources/adme/methods/start/index.md): Start an ADME prediction
  - [List](/docs/api/resources/predictions/subresources/adme/methods/list/index.md): List ADME predictions
  - [Retrieve](/docs/api/resources/predictions/subresources/adme/methods/retrieve/index.md): Retrieve an ADME prediction
  - [Delete Data](/docs/api/resources/predictions/subresources/adme/methods/delete_data/index.md): Delete ADME prediction data
  - [Estimate Cost](/docs/api/resources/predictions/subresources/adme/methods/estimate_cost/index.md): Estimate cost for an ADME prediction

### [Small Molecule](/docs/api/resources/small_molecule/index.md)


- [Design](/docs/api/resources/small_molecule/subresources/design/index.md)

  - [Start](/docs/api/resources/small_molecule/subresources/design/methods/start/index.md): Start a small molecule de novo design run
  - [List](/docs/api/resources/small_molecule/subresources/design/methods/list/index.md): List small molecule design runs
  - [Retrieve](/docs/api/resources/small_molecule/subresources/design/methods/retrieve/index.md): Get small molecule design run status
  - [List Results](/docs/api/resources/small_molecule/subresources/design/methods/list_results/index.md): Get generated small molecule designs
  - [Stop](/docs/api/resources/small_molecule/subresources/design/methods/stop/index.md): Stop a running small molecule design run
  - [Resume](/docs/api/resources/small_molecule/subresources/design/methods/resume/index.md): Resume a stopped small molecule design run
  - [Delete Data](/docs/api/resources/small_molecule/subresources/design/methods/delete_data/index.md): Delete small molecule design run data
  - [Estimate Cost](/docs/api/resources/small_molecule/subresources/design/methods/estimate_cost/index.md): Estimate cost for a small molecule design run


- [Library Screen](/docs/api/resources/small_molecule/subresources/library_screen/index.md)

  - [Start](/docs/api/resources/small_molecule/subresources/library_screen/methods/start/index.md): Start a small molecule library screen
  - [List](/docs/api/resources/small_molecule/subresources/library_screen/methods/list/index.md): List small molecule library screens
  - [Retrieve](/docs/api/resources/small_molecule/subresources/library_screen/methods/retrieve/index.md): Get small molecule library screen status
  - [List Results](/docs/api/resources/small_molecule/subresources/library_screen/methods/list_results/index.md): Get screened small molecule candidates
  - [Stop](/docs/api/resources/small_molecule/subresources/library_screen/methods/stop/index.md): Stop a running small molecule library screen
  - [Resume](/docs/api/resources/small_molecule/subresources/library_screen/methods/resume/index.md): Resume a stopped small molecule library screen
  - [Delete Data](/docs/api/resources/small_molecule/subresources/library_screen/methods/delete_data/index.md): Delete small molecule library screen data
  - [Estimate Cost](/docs/api/resources/small_molecule/subresources/library_screen/methods/estimate_cost/index.md): Estimate cost for a small molecule library screen


- [Explore](/docs/api/resources/small_molecule/subresources/explore/index.md)

  - [Start](/docs/api/resources/small_molecule/subresources/explore/methods/start/index.md): Start a small molecule library exploration
  - [Retrieve](/docs/api/resources/small_molecule/subresources/explore/methods/retrieve/index.md): Get small molecule exploration status
  - [List Results](/docs/api/resources/small_molecule/subresources/explore/methods/list_results/index.md): Get scored molecules from an exploration
  - [Stop](/docs/api/resources/small_molecule/subresources/explore/methods/stop/index.md): Stop a running small molecule exploration
  - [Resume](/docs/api/resources/small_molecule/subresources/explore/methods/resume/index.md): Resume a stopped small molecule exploration

### [Protein](/docs/api/resources/protein/index.md)


- [Design](/docs/api/resources/protein/subresources/design/index.md)

  - [Start](/docs/api/resources/protein/subresources/design/methods/start/index.md): Start a protein design run
  - [List](/docs/api/resources/protein/subresources/design/methods/list/index.md): List protein design runs
  - [List Curated Specifications](/docs/api/resources/protein/subresources/design/methods/list_curated_specifications/index.md): List curated protein design specifications
  - [Retrieve](/docs/api/resources/protein/subresources/design/methods/retrieve/index.md): Get protein design run status
  - [List Results](/docs/api/resources/protein/subresources/design/methods/list_results/index.md): Get generated protein designs
  - [Stop](/docs/api/resources/protein/subresources/design/methods/stop/index.md): Stop a running protein design run
  - [Resume](/docs/api/resources/protein/subresources/design/methods/resume/index.md): Resume a stopped protein design run
  - [Delete Data](/docs/api/resources/protein/subresources/design/methods/delete_data/index.md): Delete protein design run data
  - [Estimate Cost](/docs/api/resources/protein/subresources/design/methods/estimate_cost/index.md): Estimate cost for a protein design run


- [Sequence Redesign](/docs/api/resources/protein/subresources/sequence_redesign/index.md)

  - [Start](/docs/api/resources/protein/subresources/sequence_redesign/methods/start/index.md): Start a protein sequence redesign run
  - [List](/docs/api/resources/protein/subresources/sequence_redesign/methods/list/index.md): List protein sequence redesign runs
  - [Retrieve](/docs/api/resources/protein/subresources/sequence_redesign/methods/retrieve/index.md): Get protein sequence redesign run status
  - [List Results](/docs/api/resources/protein/subresources/sequence_redesign/methods/list_results/index.md): Get redesigned protein sequences
  - [Stop](/docs/api/resources/protein/subresources/sequence_redesign/methods/stop/index.md): Stop a running protein sequence redesign run
  - [Resume](/docs/api/resources/protein/subresources/sequence_redesign/methods/resume/index.md): Resume a stopped protein sequence redesign run
  - [Delete Data](/docs/api/resources/protein/subresources/sequence_redesign/methods/delete_data/index.md): Delete protein sequence redesign run data
  - [Estimate Cost](/docs/api/resources/protein/subresources/sequence_redesign/methods/estimate_cost/index.md): Estimate cost for a protein sequence redesign run


- [Library Screen](/docs/api/resources/protein/subresources/library_screen/index.md)

  - [Start](/docs/api/resources/protein/subresources/library_screen/methods/start/index.md): Start a protein library screen
  - [List](/docs/api/resources/protein/subresources/library_screen/methods/list/index.md): List protein library screens
  - [Retrieve](/docs/api/resources/protein/subresources/library_screen/methods/retrieve/index.md): Get protein library screen status
  - [List Results](/docs/api/resources/protein/subresources/library_screen/methods/list_results/index.md): Get screened protein candidates
  - [Stop](/docs/api/resources/protein/subresources/library_screen/methods/stop/index.md): Stop a running protein library screen
  - [Resume](/docs/api/resources/protein/subresources/library_screen/methods/resume/index.md): Resume a stopped protein library screen
  - [Delete Data](/docs/api/resources/protein/subresources/library_screen/methods/delete_data/index.md): Delete protein library screen data
  - [Estimate Cost](/docs/api/resources/protein/subresources/library_screen/methods/estimate_cost/index.md): Estimate cost for a protein library screen

### [Share Links](/docs/api/resources/share_links/index.md)

- [Create](/docs/api/resources/share_links/methods/create/index.md): Create a share link
- [Retrieve](/docs/api/resources/share_links/methods/retrieve/index.md): Retrieve a share link
- [Archive](/docs/api/resources/share_links/methods/archive/index.md): Archive a share link
- [Read](/docs/api/resources/share_links/methods/read/index.md): Read a share link
- [List Pipeline Results](/docs/api/resources/share_links/methods/list_pipeline_results/index.md): List pipeline results from a share link


### [Admin](/docs/api/resources/admin/index.md)


- [Workspaces](/docs/api/resources/admin/subresources/workspaces/index.md)

  - [Create](/docs/api/resources/admin/subresources/workspaces/methods/create/index.md): Create a workspace
  - [List](/docs/api/resources/admin/subresources/workspaces/methods/list/index.md): List workspaces
  - [Retrieve](/docs/api/resources/admin/subresources/workspaces/methods/retrieve/index.md): Get a workspace
  - [Update](/docs/api/resources/admin/subresources/workspaces/methods/update/index.md): Update a workspace
  - [Archive](/docs/api/resources/admin/subresources/workspaces/methods/archive/index.md): Archive a workspace
  - [Retrieve Spending Limit](/docs/api/resources/admin/subresources/workspaces/methods/retrieve_spending_limit/index.md): Get a workspace spending limit
  - [Set Spending Limit](/docs/api/resources/admin/subresources/workspaces/methods/set_spending_limit/index.md): Set a workspace spending limit


- [API Keys](/docs/api/resources/admin/subresources/api_keys/index.md)

  - [Create](/docs/api/resources/admin/subresources/api_keys/methods/create/index.md): Create a workspace API key
  - [List](/docs/api/resources/admin/subresources/api_keys/methods/list/index.md): List API keys
  - [Revoke](/docs/api/resources/admin/subresources/api_keys/methods/revoke/index.md): Revoke an API key


- [Usage](/docs/api/resources/admin/subresources/usage/index.md)

  - [List](/docs/api/resources/admin/subresources/usage/methods/list/index.md): Get usage data

### [Cli](/docs/api/resources/cli/index.md)

- [Version](/docs/api/resources/cli/methods/version/index.md): CLI version metadata


### [Auth](/docs/api/resources/auth/index.md)

- [Me](/docs/api/resources/auth/methods/me/index.md): Get current compute auth context