Sign in

v19

latestOpenAPI 3.0.3raw.githubusercontent.com2025-06-29204858.4 KB
Tool

Create tool

Create a tool in your project.

post/v1/tools

Request body

codestring required

The code of the tool. You must define a function named "execute" that takes in a single argument and returns a JSON-serializable value. The argument will be the "input" passed when executing the tool, and will match the input schema.

descriptionstring

A description of the tool.

{"stackTrail":"components:schemas:CreateToolRequest:properties:input_schema","oasType":"schema","type":"unknown","description":"The input schema of the tool. This must be a valid JSON Schema object."}
language'python' | 'javascript' | 'typescript' required

The language of the tool's code.

namestring required

The name of the tool.

runtime_revision_idstring

The ID of the runtime revision to use when executing the tool.

Response

OK

codestring required

The code of the tool. You must define a function named "execute" that takes in a single argument and returns a JSON-serializable value. The argument will be the "input" passed when executing the tool, and will match the input schema.

descriptionstring required

A description of the tool.

idstring required

The ID of the tool.

{"stackTrail":"components:schemas:Tool:properties:input_schema","oasType":"schema","type":"unknown","description":"The input schema of the tool. This must be a valid JSON Schema object."}
language'python' | 'javascript' | 'typescript' required

The language of the tool's code.

namestring required

The name of the tool.

revision_idstring required

The ID of the tool's current revision. This is used to pin executions to a specific version of the tool, even if the tool is updated later.

runtime_revision_idstring

The ID of the custom runtime revision that the tool uses for executions. This pins executions to specific version of a custom runtime runtime, even if the runtime is updated later.