Get built-in tool schema | Runtype Documentation

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

{
  "description": "A built-in tool for text summarization that condenses long documents into concise summaries.",
  "id": "text-summarizer-v1",
  "name": "Text Summarizer",
  "parametersSchema": {
    "maxSummaryLength": {
      "type": "integer",
      "minimum": 10,
      "maximum": 500,
      "default": 150,
      "description": "Maximum length of the generated summary in words."
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "de"
      ],
      "default": "en",
      "description": "Language of the input text."
    },
    "includeKeywords": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include key phrases in the summary."
    }
  },
  "defaultConfig": {
    "timeout": 30,
    "retry": 3,
    "verbose": false
  }
}

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

descriptionstring

idstring

namestring

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: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"description": "A built-in tool for text summarization that condenses long documents into concise summaries.",
3	"id": "text-summarizer-v1",
4	"name": "Text Summarizer",
5	"parametersSchema": {
6	"maxSummaryLength": {
7	"type": "integer",
8	"minimum": 10,
9	"maximum": 500,
10	"default": 150,
11	"description": "Maximum length of the generated summary in words."
12	},
13	"language": {
14	"type": "string",
15	"enum": [
16	"en",
17	"es",
18	"fr",
19	"de"
20	],
21	"default": "en",
22	"description": "Language of the input text."
23	},
24	"includeKeywords": {
25	"type": "boolean",
26	"default": true,
27	"description": "Whether to include key phrases in the summary."
28	}
29	},
30	"defaultConfig": {
31	"timeout": 30,
32	"retry": 3,
33	"verbose": false
34	}
35	}