custom-tools

Update a custom tool

Update a custom tool's metadata or compute resources.

Fields you omit are left unchanged.

patch/api/custom-tools/{name}

Request

  • Base URL: https://app.tamarind.bio
  • URL: https://app.tamarind.bio/api/custom-tools/{name}
  • Auth: API key in header x-api-key

Path parameters

namestring required

The custom tool name.

Headers

If-Matchstring

Optional: send the etag field returned in the Get tool JSON body, including its quotes, to avoid overwriting changes made since that read. Standard If-Match lists and * are also accepted; * checks only that the tool exists. Without this header, changes apply to the current tool state and may overwrite concurrent edits.

Request body

autoPublishboolean nullable

Whether successful builds become the default version automatically. Omit or pass null to leave it unchanged.

cpuinteger nullable

Number of CPU cores allocated to each run. Omit or pass null to leave it unchanged.

descriptionstring nullable

Short explanation of the tool. Omit or pass null to leave it unchanged; pass an empty string to clear it.

displayNamestring nullable

Human-readable name shown in the UI. Omit or pass null to leave it unchanged; pass an empty string to clear it.

estTimestring nullable

Estimated 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.

functionsstring[] nullable

Short capability labels used for discovery. Omit or pass null to leave them unchanged; pass an empty list to clear them.

gpuType'None' | 'T4' | 'L4' | 'L40S' | 'A10' | 'A100' nullable

GPU allocated to each run: "None", T4, L4, L40S, or A100. Omit or pass null to leave it unchanged. A10 is retired: it is still accepted and runs on L4.

homeDiskGiinteger nullable

Writable home-disk capacity in GiB. Omit or pass null to leave it unchanged.

memory'8Gi' | '12Gi' | '24Gi' | '32Gi' | '48Gi' | '64Gi' | '90Gi' | '96Gi' | '180Gi' nullable

Memory allocated to each run. Omit or pass null to leave it unchanged.

paperUrlstring nullable

Related HTTP or HTTPS publication URL. Omit or pass null to leave it unchanged; pass an empty string to clear it.

tagsstring[] nullable

Search and discovery tags. Omit or pass null to leave them unchanged; pass an empty list to clear them.

Response

The updated Tool.

autoPublishboolean required
canBuildboolean required
canEditboolean required
cpuinteger required
createdAtstring required
defaultVersionstring nullable required

The version used by default, such as v3. Null when no version is published.

descriptionstring required
displayNamestring required
estTimestring required
etagstring required

Opaque SDK-managed validator for this Tool snapshot.

functionsstring[] required
gpuType'None' | 'T4' | 'L4' | 'L40S' | 'A10' | 'A100' required
hasSourceboolean required
homeDiskGiinteger required
maxRuntimeSecondsinteger nullable required

Maximum runtime for a tool run, in seconds. Null means no tool-specific limit.

memory'8Gi' | '12Gi' | '24Gi' | '32Gi' | '48Gi' | '64Gi' | '90Gi' | '96Gi' | '180Gi' required
namestring required
paperUrlstring required
publishedboolean required
sourceDigeststring nullable required

SHA-256 digest of the current source archive after it has been admitted for a build. Null when the current source is unbuilt, absent, or hidden.

status'Draft' | 'Building' | 'Deployed' required
tagsstring[] required
updatedAtstring required

Changes

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