API Documentation

Run Saved Pipelines

POST/api/run-pipeline

Execute previously saved computational pipelines with multiple nodes.

The POST API endpoint /run-pipeline allows users to execute pre-saved computational pipelines with multiple nodes.

Required Parameters:

jobName

(string)

The name of your job

pipelineName

(string)

The name of the pre-saved pipeline to run

initialInputs

(array)

Array of inputs for the pipeline:
• PDB/SDF input: list of files uploaded using the /upload endpoint
• Sequence input: list of sequence strings or fasta/fa files uploaded using the /upload endpoint
• SMILES input: list of SMILES strings

HTTP Response Status Codes
Status codeDescription
200Pipeline execution submitted successfully
400Bad request
403Forbidden - Budget Exceeded
404Pipeline not found
500Internal server error
Example Usage:

The below example shows how to run a pre-saved pipeline named "myPipelineName" with PDB file inputs. The pipeline must already be created. For PDB file inputs, make sure to use the /upload endpoint and upload your files before submitting.

Initial Inputs (one per line)

1import requests
2
3api_key = "your_api_key_here"
4base_url = "https://app.tamarind.bio/api/"
5
6initialInputs = [
7    "5TPN.pdb"
8]  # PDB files (must be uploaded first) or protein sequences
9
10params = {
11    "jobName": "myPipelineRun",
12    "pipelineName": "mySavedPipeline", # saved pipeline from the website
13    "initialInputs": initialInputs
14}
15
16response = requests.post(base_url + "run-pipeline", headers={'x-api-key': api_key}, json=params)
17print(response.text)
Response Format
Pipeline "myPipelineName" execution "myJobName" submitted to queue with 3 jobs.