Generate tool inputs from natural language

Uses AI to translate a natural language description into structured arguments for a specific tool. This endpoint is useful when you want to let users describe what they want to do in plain language instead of providing structured parameters.

Path parameters

tool_slugstringRequired

The tool slug to generate inputs for

Headers

x-api-keystringRequired

Request

This endpoint expects an object.

textstringRequired

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

custom_descriptionstringOptional

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

system_promptstringOptional

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

versionstringOptional

Tool version to use when generating inputs (defaults to “latest” if not specified)

Response

Successfully generated structured inputs for the action based on natural language description

argumentsmap from strings to any or null

Key-value pairs of arguments required by the tool to accomplish the described task

errorstring or null

Error message if the arguments could not be generated (null if successful)

1	curl -X POST https://backend.composio.dev/api/v3/tools/execute/tool_slug/input \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"text": "I need to trigger the main workflow in the octocat/Hello-World repository to deploy to production"
6	}'

1	{
2	"arguments": {
3	"repository": "octocat/Hello-World",
4	"workflow_id": "main.yml",
5	"ref": "main",
6	"inputs": {
7	"environment": "production"
8	}
9	},
10	"error": "Unable to determine the repository name from the provided description"
11	}

Path parameters

Headers

Request

Response

Errors