v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

agents

Toggle a tool for an agent

Enable or disable a single built-in or custom tool for a V2 chat agent. Requires a token with write access.

patch/v1/agents/{id}/tools

Path parameters

idstring required

V2 chat agent id.

Example:ag77c0dy0mgdpzmqz6tesry8w184002s

Query parameters

workspace_idstring

Optional workspace override. If omitted, Conduit resolves the agent's workspace automatically.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Request body

tool_namestring required

Name of the tool to toggle, as returned by GET /v1/agents/{id}/tools.

source'builtin' | 'custom' required

builtin for a platform tool from the tools catalog, custom for a workspace custom code tool.

enabledboolean required

Set true to enable the tool for this agent, false to disable.

Example request

{
  "tool_name": "lookup-order-status",
  "source": "custom",
  "enabled": true
}

Response

Updated tool access

Example response

{
  "data": {
    "id": "kg77c0dy0mgdpzmqz6tesry8w184002s",
    "name": "lookup-order-status",
    "source": "custom",
    "description": "Look up the fulfillment status of an order by id.",
    "enabled": true,
    "domain": null,
    "tags": [],
    "language": "python"
  }
}