Sign in

Update tool

Update tool

put/v1/Tools/{id}

Path parameters

idstring required

Request body

assistant_idstring

The Assistant ID.

descriptionstring

The description of the tool.

enabledboolean

True if the tool is enabled.

metaobject

The metadata related to method, url, input_schema to used with the Tool.

namestring

The name of the tool.

typestring

The type of the tool.

Response

OK

account_sidstring

The SID of the Account that created the Tool resource.

descriptionstring required

The description of the tool.

enabledboolean required

True if the tool is enabled.

idstring required

The tool ID.

metaobject required

The metadata related to method, url, input_schema to used with the Tool.

namestring required

The name of the tool.

requires_authboolean required

The authentication requirement for the tool.

typestring required

The type of the tool. ('WEBHOOK')

urlstring

The url of the tool resource.

date_createdstring date-time required

The date and time in GMT when the Tool was created specified in ISO 8601 format.

date_updatedstring date-time required

The date and time in GMT when the Tool was last updated specified in ISO 8601 format.

Changes

Changed in 2 of the 10 revisions of this API.22

  • v10852198458a021See the full diff
    • ●

      changed the pattern of the request property assistant_id from ^aia_asst_*$ to ^aia_asst_.+$

      request-property-pattern-changed

    • ●

      changed the pattern of the request property policy/id from ^aia_plcy_*$ to ^aia_plcy_.+$

      request-property-pattern-changed

    • ○

      the id response's property pattern was changed from ^aia_tool_*$ to ^aia_tool_.+$ for the status 200

      response-property-pattern-changed

  • v11ad87f675d4b1See the full diff
    • ○

      added the optional property url to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog