Create tool | Runtype Documentation

curl -X POST https://api.runtype.com/v1/tools \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "config": {
    "code": "const { operation, a, b } = parameters; switch(operation) { case '\''add'\'': return { result: a + b }; case '\''subtract'\'': return { result: a - b }; case '\''multiply'\'': return { result: a * b }; case '\''divide'\'': return { result: a / b }; }",
    "timeout": 5000
  },
  "description": "A simple calculator for basic math operations",
  "name": "Calculator Tool",
  "parametersSchema": {
    "properties": {
      "a": {
        "description": "First number",
        "type": "number"
      },
      "b": {
        "description": "Second number",
        "type": "number"
      },
      "operation": {
        "description": "The math operation to perform",
        "enum": [
          "add",
          "subtract",
          "multiply",
          "divide"
        ],
        "type": "string"
      }
    },
    "required": [
      "operation",
      "a",
      "b"
    ],
    "type": "object"
  },
  "toolType": "custom"
}'

{
  "config": {},
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "name": "string",
  "organizationId": "string",
  "toolType": "string",
  "updatedAt": "string",
  "userId": "string",
  "lastModifiedSource": "string",
  "parametersSchema": {},
  "validation": {
    "warnings": [
      {
        "code": "string",
        "message": "string",
        "severity": "error",
        "column": 1.1,
        "line": 1.1,
        "suggestion": "string"
      }
    ],
    "recommendations": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "step": {
          "index": 1,
          "name": "string",
          "type": "string"
        }
      }
    ]
  }
}

Create a new tool definition.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

configmap from strings to anyRequired

descriptionstringRequired1-500 characters

namestringRequired1-100 characters

parametersSchemamap from strings to anyRequired

toolTypeenumRequired

Response

Created tool

configmap from strings to any or null

createdAtstring

descriptionstring or null

idstring

isActiveboolean

namestring

organizationIdstring or null

toolTypestring

updatedAtstring

userIdstring or null

lastModifiedSourcestring or nullOptional

parametersSchemamap from strings to anyOptional

validationobjectOptional

Non-blocking findings from a successful write. warnings also carries SESSION_PREVIEW_URL when config.url or config.serverUrl is a session sandbox preview URL, which stops working when that sandbox container stops.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error