Update a tool

PUT/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}

Updates a tool in the tool set

Path ParametersExpand Collapse

workspaceId: string

toolSetId: string

id: string

Body ParametersJSONExpand Collapse

metadata: optional UpdateResourceMetadata { name, bundleKey, externalId, labels }

UpdateResourceMetadata contains the user-provided fields for updating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”)

bundleKey: optional string

Optional bundle ownership key. See ResourceMetadata.bundle_key.

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: optional ToolSpec { config, description, parameters, 2 more }

config: ToolSpecConfig { http, mcp, openapi }

Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline.

http: optional ConfigHTTP { requestMethod, headers, path, 4 more }

requestMethod: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"GET"

"POST"

"PUT"

"PATCH"

"DELETE"

headers: optional map[string]

path: optional string

query: optional string

requestBodyContentType: optional string

requestBodyTemplate: optional string

These are only used when the request method is a POST, PUT, or PATCH

toolName: optional string

The tool name (commonly an “operation id” in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided.

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

openapi: optional ConfigOpenAPI { method, operationId, path }

method: optional string

operationId: optional string

path: optional string

description: string

parameters: map[unknown]

status: "TOOL_STATUS_UNSPECIFIED" or "TOOL_STATUS_AVAILABLE" or "TOOL_STATUS_OMITTED" or "TOOL_STATUS_ARCHIVED"

formatenum

One of the following:

"TOOL_STATUS_UNSPECIFIED"

"TOOL_STATUS_AVAILABLE"

"TOOL_STATUS_OMITTED"

"TOOL_STATUS_ARCHIVED"

requiresApproval: optional boolean

updateMask: optional string

ReturnsExpand Collapse

Tool object { metadata, spec, info }

metadata: ResourceMetadata { id, accountId, createdAt, 6 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., “agent_01HXK…”)

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

bundleKey: optional string

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ToolSpec { config, description, parameters, 2 more }

config: ToolSpecConfig { http, mcp, openapi }

http: optional ConfigHTTP { requestMethod, headers, path, 4 more }

requestMethod: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"GET"

"POST"

"PUT"

"PATCH"

"DELETE"

headers: optional map[string]

path: optional string

query: optional string

requestBodyContentType: optional string

requestBodyTemplate: optional string

These are only used when the request method is a POST, PUT, or PATCH

toolName: optional string

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

openapi: optional ConfigOpenAPI { method, operationId, path }

method: optional string

operationId: optional string

path: optional string

description: string

parameters: map[unknown]

status: "TOOL_STATUS_UNSPECIFIED" or "TOOL_STATUS_AVAILABLE" or "TOOL_STATUS_OMITTED" or "TOOL_STATUS_ARCHIVED"

formatenum

One of the following:

"TOOL_STATUS_UNSPECIFIED"

"TOOL_STATUS_AVAILABLE"

"TOOL_STATUS_OMITTED"

"TOOL_STATUS_ARCHIVED"

requiresApproval: optional boolean

info: optional ToolInfo { createdBy, toolSet }

createdBy: optional Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profileId: string

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: "PROFILE_TYPE_UNSPECIFIED" or "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

Email address of the profile. Required and unique within an account for user profiles.

Display name (e.g., “Bobby Tables”).

toolSet: optional ResourceMetadata { id, accountId, createdAt, 6 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., “agent_01HXK…”)

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

bundleKey: optional string

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

Update a tool

curl https://api.cadenya.com/v1/workspaces/$WORKSPACE_ID/tool_sets/$TOOL_SET_ID/tools/$ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CADENYA_API_KEY" \
    -d '{}'

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "bundleKey": "bundleKey",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "config": {
      "http": {
        "requestMethod": "HTTP_METHOD_UNSPECIFIED",
        "headers": {
          "foo": "string"
        },
        "path": "path",
        "query": "query",
        "requestBodyContentType": "requestBodyContentType",
        "requestBodyTemplate": "requestBodyTemplate",
        "toolName": "toolName"
      },
      "mcp": {
        "toolDescription": "toolDescription",
        "toolName": "toolName",
        "toolTitle": "toolTitle"
      },
      "openapi": {
        "method": "method",
        "operationId": "operationId",
        "path": "path"
      }
    },
    "description": "description",
    "parameters": {
      "foo": "bar"
    },
    "status": "TOOL_STATUS_UNSPECIFIED",
    "requiresApproval": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "email": "email",
        "name": "name"
      }
    },
    "toolSet": {
      "id": "id",
      "accountId": "accountId",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "profileId": "profileId",
      "workspaceId": "workspaceId",
      "bundleKey": "bundleKey",
      "externalId": "externalId",
      "labels": {
        "foo": "string"
      }
    }
  }
}

Returns Examples

{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "bundleKey": "bundleKey",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "config": {
      "http": {
        "requestMethod": "HTTP_METHOD_UNSPECIFIED",
        "headers": {
          "foo": "string"
        },
        "path": "path",
        "query": "query",
        "requestBodyContentType": "requestBodyContentType",
        "requestBodyTemplate": "requestBodyTemplate",
        "toolName": "toolName"
      },
      "mcp": {
        "toolDescription": "toolDescription",
        "toolName": "toolName",
        "toolTitle": "toolTitle"
      },
      "openapi": {
        "method": "method",
        "operationId": "operationId",
        "path": "path"
      }
    },
    "description": "description",
    "parameters": {
      "foo": "bar"
    },
    "status": "TOOL_STATUS_UNSPECIFIED",
    "requiresApproval": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "email": "email",
        "name": "name"
      }
    },
    "toolSet": {
      "id": "id",
      "accountId": "accountId",
      "createdAt": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "profileId": "profileId",
      "workspaceId": "workspaceId",
      "bundleKey": "bundleKey",
      "externalId": "externalId",
      "labels": {
        "foo": "string"
      }
    }
  }
}