Update tool | Runtype Documentation

curl -X PUT https://api.runtype.com/v1/tools/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
  "name": "Content Summarizer",
  "description": "A tool that generates concise summaries from long-form content using advanced NLP techniques.",
  "toolType": "text-processing",
  "isActive": true,
  "createdAt": "2024-05-10T09:15:00Z",
  "updatedAt": "2024-06-01T12:00:00Z",
  "userId": "user_987654321",
  "organizationId": "org_123456789",
  "config": {},
  "parametersSchema": {},
  "validation": {
    "warnings": [
      {
        "severity": "warning",
        "code": "PARAM_SCHEMA_DEPRECATED",
        "message": "The 'maxLength' parameter is deprecated and will be removed in future versions.",
        "suggestion": "Remove 'maxLength' from the parameters schema to avoid future issues.",
        "line": 12,
        "column": 5
      }
    ]
  }
}

Update fields on an existing tool.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional1-100 characters

descriptionstringOptional1-5000 characters

parametersSchemamap from strings to anyOptional

configmap from strings to anyOptional

isActivebooleanOptional

Response

Updated tool

idstring

namestring

descriptionstring or null

toolTypestring

isActiveboolean

createdAtstring

updatedAtstring

userIdstring

organizationIdstring or null

configmap from strings to any or null

parametersSchemamap from strings to any

validationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X PUT https://api.runtype.com/v1/tools/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
3	"name": "Content Summarizer",
4	"description": "A tool that generates concise summaries from long-form content using advanced NLP techniques.",
5	"toolType": "text-processing",
6	"isActive": true,
7	"createdAt": "2024-05-10T09:15:00Z",
8	"updatedAt": "2024-06-01T12:00:00Z",
9	"userId": "user_987654321",
10	"organizationId": "org_123456789",
11	"config": {},
12	"parametersSchema": {},
13	"validation": {
14	"warnings": [
15	{
16	"severity": "warning",
17	"code": "PARAM_SCHEMA_DEPRECATED",
18	"message": "The 'maxLength' parameter is deprecated and will be removed in future versions.",
19	"suggestion": "Remove 'maxLength' from the parameters schema to avoid future issues.",
20	"line": 12,
21	"column": 5
22	}
23	]
24	}
25	}