API Documentation
Overview
Python SDK Reference
End to End example
List custom tools
Get a custom tool
Create a custom tool
Update a custom tool
Delete a custom tool
Create a source upload
Build a custom tool
List build logs
Cancel a custom tool build
Run a custom tool
Publish a custom tool version
List custom tool versions
View Jobs
/api/jobsThe GET API endpoint /jobs returns your submitted jobs, including their names, statuses, types, and timestamps. The statuses counts describe only the jobs in this response. For paginated results, they count this page, not the entire batch or organization.
Optional Parameters:
jobName
= "myJobName"
Return one job given its name. For a batch, pass the batch name to get its parent job, including batchStatus. To look up many names at once, use POST /jobs/search.
batch
= "myBatchName"
Return the subjobs in a batch, one page at a time; follow startKey for the rest.
batchOnly
= "true"
Only return jobs with Type = batch.
startKey
= (key)
Use a previously returned startKey to retrieve more jobs.
limit
= (int)
Limit the number of jobs returned, up to 1000. If more jobs are available, a startKey is returned.
organization
= "true"
Return all jobs visible in your organization.
jobEmail
= "user@email.com"
Return jobs for another visible member of your organization.
HTTP Response Status Codes
| Status code | Description |
|---|---|
| 200 | Successfully retrieved jobs |
| 400 | Invalid limit or cursor, inaccessible member, or no exact job or batch matches |
| 401 | Application authentication failed |
| 403 | Gateway authentication failed, or account access policy forbids the request |
| 503 | A dependency required by the Jobs API is unavailable |
View your jobs. By default, batch children are omitted.
1import requests
2
3api_key = "***************"
4headers = {'x-api-key': api_key}
5base_url = "https://app.tamarind.bio/api/"
6
7response = requests.get(base_url + "jobs", headers=headers)
8response.raise_for_status()
9print(response.json())Response Format
1{
2 "jobs": [
3 {
4 "JobName": "myJobName",
5 "JobStatus": "Complete",
6 "Type": "immunebuilder",
7 "Started": "2025-12-12 05:38:29",
8 "Completed": "2025-12-12 05:38:44",
9 "Created": "2025-12-12 05:38:03",
10 "Settings": "{\"sequence\":\"EVQLVESGGGLVQPGGSLRLSCAAS\"}",
11 "Score": "0.91",
12 "TamarindSchemaVersion": "v3",
13 "WeightedHours": 0.01
14 }
15 ],
16 "startKey": "11111111-1111-4111-8111-111111111111",
17 "statuses": {
18 "Complete": 1,
19 "In Queue": 0,
20 "Running": 0,
21 "Stopped": 0
22 }
23}