API Documentation

Build a custom tool

POST/api/custom-tools/{name}/build

Build a version from an uploaded source archive. The archive also updates the tool’s editable source and configuration. Returns immediately with the new or reused version and its current status.

Python SDK equivalenttool.build(source_dir)

Builds progress through Queued, Running, and then Complete or Stopped. The build response includes the version string at version.version, such as v1. Use this string when checking build status or logs, cancelling or publishing the build, and when submitting a job.

Parameters
namepathrequired

The custom tool name.

Idempotency-Keyheaderoptional

Retries the same build request without admitting duplicate work. Reusing a key with different source or runtime facts returns 409 Conflict.

uploadIdbodystringrequired

The uploadId returned when the source upload was created.

HTTP Response Status Codes
Status codeDescription
202The admitted Version.
401API key missing or invalid.
404The addressed resource does not exist, or is not visible to your tenant.
409The request conflicts with current resource state.
412A supplied request condition did not match the current resource. Fetch the resource again before retrying.
422The 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/build"
5headers = {"x-api-key": api_key}
6
7payload = {
8    "uploadId": "string"
9}
10resp = requests.post(url, headers=headers, json=payload)
11print(resp.status_code, resp.json())
Response
1{
2  "action": "build",
3  "version": "v1"
4}