{ "name": "GetFileWatermark", "fully_qualified_name": "BoxApi.GetFileWatermark@0.1.0", "description": "Retrieve the watermark for a file by its ID.\n\nUse this tool to get the watermark information of a specific file. It requires the file ID to identify which file's watermark needs to be retrieved.", "toolkit": { "name": "ArcadeBoxApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "file_identifier", "required": true, "description": "The unique identifier of a file. Obtainable from the URL when viewing a file on the web application.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, "inferrable": true, "http_endpoint_parameter_name": "file_id" } ] }, "output": { "description": "Response from the API endpoint 'get_files_id_watermark'.", "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/files/{file_id}/watermark", "http_method": "GET", "headers": { "box-version": "2024.0" }, "parameters": [ { "name": "file_id", "tool_parameter_name": "file_identifier", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, "accepted_as": "path", "required": true, "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 } ] } }