{ "name": "DeleteFolder", "fully_qualified_name": "BoxApi.DeleteFolder@0.1.0", "description": "Delete a folder permanently or move it to the trash.\n\nUse this tool to remove a folder from Box, either permanently or by sending it to the trash.", "toolkit": { "name": "ArcadeBoxApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "folder_identifier", "required": true, "description": "The unique identifier representing a folder. Determine it by copying the ID from the folder's URL in the Box web application. The root folder ID is '0'.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, "inferrable": true, "http_endpoint_parameter_name": "folder_id" }, { "name": "ensure_unchanged_etag", "required": false, "description": "Last observed `etag` value to ensure the folder hasn't changed before deletion. If changed, the operation fails with a 412 error.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since." }, "inferrable": true, "http_endpoint_parameter_name": "if-match" }, { "name": "delete_recursively", "required": false, "description": "Set to true to delete a non-empty folder and all its content recursively.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content." }, "inferrable": true, "http_endpoint_parameter_name": "recursive" } ] }, "output": { "description": "Response from the API endpoint 'delete_folders_id'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-box", "provider_type": "oauth2", "id": null, "oauth2": null }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.0.0", "description": "Tools that enable LLMs to interact directly with the box API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.0.0", "description": "" }, "url": "https://api.box.com/2.0/folders/{folder_id}", "http_method": "DELETE", "headers": { "box-version": "2024.0" }, "parameters": [ { "name": "recursive", "tool_parameter_name": "delete_recursively", "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "folder_id", "tool_parameter_name": "folder_identifier", "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, "accepted_as": "path", "required": true, "deprecated": false, "documentation_urls": [] }, { "name": "if-match", "tool_parameter_name": "ensure_unchanged_etag", "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since." }, "accepted_as": "header", "required": false, "deprecated": false, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ] } }