Get tool

Get tool

get/v1/Tools/{id}

Path parameters

idstring required

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 3 of the 10 revisions of this API.116

  • v1bd3fb6f26e74113See the full diff
    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • removed assistants.v1.service.tool subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • added the optional property account_sid to the response with the 200 status

      response-optional-property-added

    • added the optional property policies to the response with the 200 status

      response-optional-property-added

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

      response-optional-property-added

    • added the required property date_created to the response with the 200 status

      response-required-property-added

    • added the required property date_updated to the response with the 200 status

      response-required-property-added

    • added the required property description to the response with the 200 status

      response-required-property-added

    • added the required property enabled to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property meta to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property requires_auth to the response with the 200 status

      response-required-property-added

    • added the required property type to the response with the 200 status

      response-required-property-added

    • the allOf[assistants.v1.service.tool]/id response's property pattern was changed from ^aia_tool_*$ to ^aia_tool_.+$ for the status 200

      response-property-pattern-changed

    • the allOf[subschema #2]/policies/items/id response's property pattern was changed from ^aia_plcy_*$ to ^aia_plcy_.+$ for the status 200

      response-property-pattern-changed

    • endpoint added

      endpoint-added

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