For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList tools
      • POSTCreate tool
      • GETGet tool schemas
      • GETList built-in tools
      • GETList compatible built-in tools
      • GETGet built-in tool schema
      • GETGet tool details
      • PUTUpdate tool
      • DELDelete tool
Dashboard
LogoLogo
Runtype APITools

Create tool

POST
/v1/tools
POST
/v1/tools
$curl -X POST https://api.runtype.com/v1/tools \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Data Transformation Flow",
>  "description": "A flow tool designed to transform incoming data streams into structured JSON outputs.",
>  "toolType": "flow",
>  "parametersSchema": {},
>  "config": {}
>}'
1{
2  "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f9a1c4d",
3  "name": "Data Transformation Flow",
4  "description": "A flow tool designed to transform incoming data streams into structured JSON outputs.",
5  "toolType": "flow",
6  "isActive": true,
7  "createdAt": "2024-06-01T10:15:30Z",
8  "updatedAt": "2024-06-01T10:15:30Z",
9  "userId": "user_7890abcd1234",
10  "organizationId": "org_5678efgh9012",
11  "config": {},
12  "parametersSchema": {},
13  "validation": {
14    "warnings": [
15      {
16        "severity": "warning",
17        "code": "PARAM_SCHEMA_EMPTY",
18        "message": "The parameters schema is currently empty.",
19        "suggestion": "Define parameters to ensure proper tool configuration.",
20        "line": 1,
21        "column": 1
22      }
23    ]
24  }
25}
Create a new tool definition.
Was this page helpful?
Previous

Get tool schemas

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
namestringRequired1-100 characters
descriptionstringRequired1-500 characters
toolTypeenumRequired
parametersSchemamap from strings to anyRequired
configmap from strings to anyRequired

Response

Created 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
500
Internal Server Error