molecules-public

Start a file import

Import molecules from a file. Step 1 of 3.

Then PUT the bytes to uploadUrl, and POST /molecules/imports/{importId}/commit to enqueue ingestion.

For a CSV, describe your chain columns with chainMapping (keyed by chain id); columnMapping handles the scalar columns only. For pdb/sdf/fasta/zip the chains are read from the file.

post/api/molecules/import-file

Request

  • Base URL: https://app.tamarind.bio
  • URL: https://app.tamarind.bio/api/molecules/import-file
  • Auth: API key in header x-api-key

Request body

groupIdstring required
fileNamestring required
fileFormat'auto' | 'csv' | 'fasta' | 'sdf' | 'pdb' | 'zip' | 'sdf_zip'

The spec's FileFormat — a STRICT SUBSET of the internal MoleculeFileFormat, which also carries cif/mmcif. The public API does not document those, so they aren't accepted here; auto still detects anything the worker can read.

sizeBytesinteger nullable

CSV imports (including fileFormat: auto with a .csv filename) may be up to 2 GiB. All other formats, including files left for content-based auto-detection, are limited to 16 MiB.

columnMappingobject nullable
chainMappingobject nullable
fastaMode'one-entity-per-file' | 'one-entity-per-header'

The public spelling of the ingestion worker's FASTA split modes.

Response

Successful Response

importIdstring required
uploadUrlstring required
uploadMethod'PUT'
uploadHeadersobject required
groupNamestring nullable required
expiresInSecondsinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.