API ReferenceTools

Generate tool inputs from natural languagev3.1Legacy

Deprecated

POST
/api/v3.1/tools/execute/{tool_slug}/input

DEPRECATED: This endpoint is no longer maintained. It still works for existing integrations but may be removed in a future release. To build tool arguments, fetch the tool's input schema with GET /api/v3/tools/{tool_slug} and generate the arguments in your own application. Uses AI to translate a natural language description into structured arguments for a specific tool.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

tool_slugstringRequired

The tool slug to generate inputs for

Request Body

application/json

textstringRequired

Natural language description of what you want to accomplish with this tool

custom_descriptionstring

Custom description of the tool to help guide the LLM in generating more accurate inputs

system_promptstring

System prompt to control and guide the behavior of the LLM when generating inputs

versionstring

Tool version to use when generating inputs. Defaults to the latest published version ("latest") when omitted.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v3.1/tools/execute/string/input" \  -H "Content-Type: application/json" \  -d '{    "text": "I need to trigger the main workflow in the octocat/Hello-World repository to deploy to production"  }'
{  "arguments": {    "repository": "octocat/Hello-World",    "workflow_id": "main.yml",    "ref": "main",    "inputs": {      "environment": "production"    }  },  "error": "Unable to determine the repository name from the provided description"}
Edit this page on GitHub