Create a tool

POST/v1/tools

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

description?|null

type*string

Value in"function" | "api" | "webhook"

toolType?|null

configuration?

Default{}

isActive?boolean

Defaulttrue

Response Body

`application/json`

cURL

curl -X POST "https://example.com/tools" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "function"  }'

{
  "success": true,
  "tool": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "type": "function",
    "toolType": "string",
    "configuration": {
      "property1": null,
      "property2": null
    },
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`