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
Update a custom tool
/api/custom-tools/{name}Update a custom tool's metadata or compute resources.
Fields you omit are left unchanged.
Parameters
namepathrequiredThe custom tool name.
autoPublishbodybooleanWhether successful builds become the default version automatically. Omit or pass null to leave it unchanged.
cpubodyintegerNumber of CPU cores allocated to each run. Omit or pass null to leave it unchanged.
descriptionbodystringShort explanation of the tool. Omit or pass null to leave it unchanged; pass an empty string to clear it.
displayNamebodystringHuman-readable name shown in the UI. Omit or pass null to leave it unchanged; pass an empty string to clear it.
estTimebodystringEstimated runtime in H:M:S format, for example "0:1:0". Minutes and seconds must be 0-59. Omit or pass null to leave it unchanged; pass an empty string to clear it.
functionsbodyarrayShort capability labels used for discovery. Omit or pass null to leave them unchanged; pass an empty list to clear them.
gpuTypebody"None" | "T4" | "L4" | "L40S" | "A10" | "A100"GPU allocated to each run: "None", T4, L4, L40S, A10, or A100. Omit or pass null to leave it unchanged.
homeDiskGibodyintegerWritable home-disk capacity in GiB. Omit or pass null to leave it unchanged.
memorybody"8Gi" | "12Gi" | "24Gi" | "32Gi" | "48Gi" | "64Gi" | "90Gi" | "96Gi" | "180Gi"Memory allocated to each run. Omit or pass null to leave it unchanged.
paperUrlbodystringRelated HTTP or HTTPS publication URL. Omit or pass null to leave it unchanged; pass an empty string to clear it.
tagsbodyarraySearch and discovery tags. Omit or pass null to leave them unchanged; pass an empty list to clear them.
Optional fields
Blank by default — enter a value to add the field to the request example.autoPublishcpudescriptiondisplayNameestTimefunctionsgpuTypehomeDiskGimemorypaperUrltagsHTTP Response Status Codes
| Status code | Description |
|---|---|
| 200 | The updated Tool. |
| 401 | API key missing or invalid. |
| 404 | The addressed resource does not exist, or is not visible to your tenant. |
| 412 | A supplied request condition did not match the current resource. Fetch the resource again before retrying. |
| 422 | The request was malformed or failed validation; see `errors` for the offending fields. |
1import requests
2
3api_key = "***************"
4url = "https://app.tamarind.bio/api/custom-tools/your-name"
5headers = {"x-api-key": api_key}
6
7payload = {}
8resp = requests.patch(url, headers=headers, json=payload)
9print(resp.status_code, resp.json())Response
1{
2 "autoPublish": false,
3 "canBuild": false,
4 "canEdit": false,
5 "cpu": 0,
6 "createdAt": "string",
7 "defaultVersion": "string",
8 "description": "string",
9 "displayName": "string",
10 "estTime": "string",
11 "functions": [
12 "string"
13 ],
14 "gpuType": "None",
15 "hasSource": false,
16 "homeDiskGi": 0,
17 "maxRuntimeSeconds": 0,
18 "memory": "8Gi",
19 "name": "string",
20 "paperUrl": "string",
21 "published": false,
22 "status": "Draft",
23 "tags": [
24 "string"
25 ],
26 "updatedAt": "string"
27}