Update tool | Runtype Documentation

curl -X PUT https://api.runtype.com/v1/tools/id \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "Enhanced calculator with more operations",
  "isActive": true,
  "name": "Updated Calculator Tool"
}'

{
  "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"
        }
      }
    ]
  }
}

Update fields on an existing tool.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

configmap from strings to anyOptional

descriptionstringOptional1-5000 characters

isActivebooleanOptional

namestringOptional1-100 characters

parametersSchemamap from strings to anyOptional

Response

Updated 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

404

Not Found Error

500

Internal Server Error