Upsert Tool | Humanloop Docs

curl -X POST https://api.humanloop.com/v5/tools \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "path": "math-tool",
  "function": {
    "name": "multiply",
    "description": "Multiply two numbers",
    "parameters": {
      "type": "object",
      "properties": {
        "a": {
          "type": "number"
        },
        "b": {
          "type": "number"
        }
      },
      "required": [
        "a",
        "b"
      ]
    }
  },
  "version_name": "math-tool-v1",
  "version_description": "Simple math tool that multiplies two numbers"
}'

{
  "path": "math-tool",
  "id": "tl_789ghi",
  "name": "math-tool",
  "version_id": "tv_012jkl",
  "created_at": "2024-05-01T12:00:00Z",
  "updated_at": "2024-05-01T12:00:00Z",
  "last_used_at": "2024-05-01T12:00:00Z",
  "version_logs_count": 1,
  "total_logs_count": 1,
  "inputs": [
    {
      "name": "operation"
    }
  ],
  "version_name": "math-tool-v1",
  "version_description": "Simple math tool that multiplies two numbers",
  "type": "tool"
}

Create a Tool or update it with a new version if it already exists.

Tools are identified by the ID or their path. The name, description and parameters determine the versions of the Tool.

You can provide version_name and version_description to identify and describe your versions. Version names must be unique within a Tool - attempting to create a version with a name that already exists will result in a 409 Conflict error.

Create a Tool or update it with a new version if it already exists. Tools are identified by the `ID` or their `path`. The name, description and parameters determine the versions of the Tool. You can provide `version_name` and `version_description` to identify and describe your versions. Version names must be unique within a Tool - attempting to create a version with a name that already exists will result in a 409 Conflict error.

Authentication

X-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

pathstringOptional

Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional

ID for an existing Tool.

functionobjectOptional

Callable function specification of the Tool shown to the model for tool calling.

source_codestringOptional

Code source of the Tool.

setup_valuesmap from strings to anyOptional

Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/

attributesmap from strings to anyOptional

Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.

tool_typeanyOptional

Type of Tool.

version_namestringOptional

Unique identifier for this Tool version. Each Tool can only have one version with a given name.

version_descriptionstringOptional

Description of the Version.

Response

Successful Response

Errors

422

Upsert Tools Post Request Unprocessable Entity Error