ASasksyllable
tools

Tool Info

Changed on

Get the details of a specific tool

get/api/v1/tools/{tool_name}

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/tools/{tool_name}
  • Auth
    API key in header Syllable-API-Key

Path parameters

tool_namestring required

Response

Successful Response

namestring required

The name of the tool

service_idinteger required

Internal ID of the service to which the tool belongs

idinteger required

The internal ID of the tool

last_updated_commentsstring nullable

Comments for the most recent edit to the tool.

service_namestring nullable

The name of the service to which the tool belongs

last_updatedstring date-time required

The timestamp of the most recent update to the tool

last_updated_bystring required

The email of the user who last updated the tool

version_numberinteger required

Highest tools_history snapshot version for this tool; the tools row defaults to 1.

fieldsstring[] required

Fields that the tool accepts as input

Changes

  • 66cde677ee38Revision changes
    • info

      added the optional property //// to the response with the status

  • b283b0df8391Revision changes
    • info

      added the optional property / to the response with the status