Get built-in tool schema | Runtype Documentation

curl https://api.runtype.com/v1/tools/builtin/toolId/schema \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "id": "text-generator",
  "name": "Text Generator",
  "description": "Generates human-like text based on the input prompt using advanced AI models.",
  "parametersSchema": {
    "prompt": {
      "type": "string",
      "description": "The input text prompt to generate completions for.",
      "maxLength": 1000
    },
    "maxTokens": {
      "type": "integer",
      "description": "Maximum number of tokens to generate in the completion.",
      "minimum": 1,
      "maximum": 2048
    },
    "temperature": {
      "type": "number",
      "description": "Controls randomness in output. Lower values make output more deterministic.",
      "minimum": 0,
      "maximum": 1
    },
    "topP": {
      "type": "number",
      "description": "Controls diversity via nucleus sampling.",
      "minimum": 0,
      "maximum": 1
    }
  },
  "defaultConfig": {
    "maxTokens": 150,
    "temperature": 0.7,
    "topP": 0.9
  }
}

Get the parameter schema and default configuration for a specific built-in tool.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

toolIdstringRequired

Response

Built-in tool parameter schema

idstring

namestring

descriptionstring

parametersSchemamap from strings to any

defaultConfigmap from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/tools/builtin/toolId/schema \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "text-generator",
3	"name": "Text Generator",
4	"description": "Generates human-like text based on the input prompt using advanced AI models.",
5	"parametersSchema": {
6	"prompt": {
7	"type": "string",
8	"description": "The input text prompt to generate completions for.",
9	"maxLength": 1000
10	},
11	"maxTokens": {
12	"type": "integer",
13	"description": "Maximum number of tokens to generate in the completion.",
14	"minimum": 1,
15	"maximum": 2048
16	},
17	"temperature": {
18	"type": "number",
19	"description": "Controls randomness in output. Lower values make output more deterministic.",
20	"minimum": 0,
21	"maximum": 1
22	},
23	"topP": {
24	"type": "number",
25	"description": "Controls diversity via nucleus sampling.",
26	"minimum": 0,
27	"maximum": 1
28	}
29	},
30	"defaultConfig": {
31	"maxTokens": 150,
32	"temperature": 0.7,
33	"topP": 0.9
34	}
35	}