Update Tool Version | Humanloop Docs

{
  "path": "path",
  "id": "id",
  "name": "name",
  "version_id": "version_id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "last_used_at": "2024-01-15T09:30:00Z",
  "version_logs_count": 1,
  "total_logs_count": 1,
  "inputs": [
    {
      "name": "name"
    }
  ],
  "directory_id": "directory_id",
  "function": {
    "name": "name",
    "description": "description",
    "strict": true,
    "parameters": {
      "key": "value"
    }
  },
  "source_code": "source_code",
  "setup_values": {
    "key": "value"
  },
  "attributes": {
    "key": "value"
  },
  "tool_type": "pinecone_search",
  "version_name": "version_name",
  "version_description": "version_description",
  "description": "description",
  "readme": "readme",
  "tags": [
    "tags"
  ],
  "type": "tool",
  "environments": [
    {
      "id": "id",
      "created_at": "2024-01-15T09:30:00Z",
      "name": "name",
      "tag": "default"
    }
  ],
  "created_by": {
    "id": "id",
    "email_address": "email_address",
    "full_name": "full_name"
  },
  "evaluators": [
    {
      "version_reference": {
        "file": {
          "path": "path",
          "id": "id",
          "model": "model",
          "name": "name",
          "version_id": "version_id",
          "created_at": "2024-01-15T09:30:00Z",
          "updated_at": "2024-01-15T09:30:00Z",
          "last_used_at": "2024-01-15T09:30:00Z",
          "version_logs_count": 1,
          "total_logs_count": 1,
          "inputs": [
            {
              "name": "name"
            }
          ]
        },
        "environment": {
          "id": "id",
          "created_at": "2024-01-15T09:30:00Z",
          "name": "name",
          "tag": "default"
        },
        "type": "environment"
      },
      "state": "active",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": {
        "path": "path",
        "id": "id",
        "spec": {
          "arguments_type": "target_free",
          "return_type": "boolean",
          "evaluator_type": "llm"
        },
        "name": "name",
        "version_id": "version_id",
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "last_used_at": "2024-01-15T09:30:00Z",
        "version_logs_count": 1,
        "total_logs_count": 1,
        "inputs": [
          {
            "name": "name"
          }
        ]
      }
    }
  ],
  "signature": "signature",
  "evaluator_aggregates": [
    {
      "value": 1.1,
      "evaluator_id": "evaluator_id",
      "evaluator_version_id": "evaluator_version_id",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ]
}

Update the name or description of the Tool version.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Tool.

version_idstringRequired

Unique identifier for the specific version of the Tool.

Request

This endpoint expects an object.

namestringOptional

Name of the version.

descriptionstringOptional

Description of the version.

Response

Successful Response

Errors

422

Update Tool Version Tools ID Versions Version ID Patch Request Unprocessable Entity Error

$	curl -X PATCH https://api.humanloop.com/v5/tools/id/versions/version_id \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'