ToolService
Tools

Create a new tool

Changed on

Creates a new tool in the tool set

post/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

toolSetIdstring required
Example:toolset_01HXKD2E5NQM3T9AYWCFNRMN74

Tool set ID. Accepts the canonical ts_… form or the external_id:<value> form.

Request body

workspaceIdstring

Workspace ID.

toolSetIdstring

Tool set ID. Accepts the canonical ts_… form or the external_id:<value> form.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "toolSetId": "toolset_01HXKD2E5NQM3T9AYWCFNRMN74"
}

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_AVAILABLE' | 'STATE_OMITTED' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the tool. Output only. Use the :omit and :restore actions to transition; tool set syncs may also update it.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "toolSet": {
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
    },
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

  • 3ecc1debabfaRevision changes
    • breaking

      the ///// request property type changed from object to no type

    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from object to no type for status

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added discriminator to ///// request property

    • info

      added to the ///// request property oneOf list

    • info

      added discriminator to ///// response property for the response status

  • ca78d3d0b7c2Revision changes
    • info

      added the new optional request property //////

    • info

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