Open Context Protocol is live! 🚀 Read the launch post
filesRemoteUpdate

filesRemoteUpdate

Updates an existing remote file.

Details

  • Method: POST
  • Path: /files.remote.update
  • Operation ID: files_remote_update

Parameters

{
  "token": {
    "description": "Authentication token. Requires scope: `remote_files:write`",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "file": {
    "description": "Specify a file by providing its ID.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "external_id": {
    "description": "Creator defined GUID for the file.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "title": {
    "description": "Title of the file being shared.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "filetype": {
    "description": "type of file",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "external_url": {
    "description": "URL of the remote file.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "preview_image": {
    "description": "Preview of the document via `multipart/form-data`.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "indexable_file_contents": {
    "description": "File containing contents that can be used to improve searchability for the remote file.",
    "required": false,
    "location": "formData",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": true,
  "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
  "properties": {
    "ok": {
      "enum": [
        true
      ],
      "title": "default success response",
      "type": "boolean"
    }
  },
  "required": [
    "ok"
  ],
  "title": "Default success template",
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('slack')

# Call this tool
result = await agent.call_tool('filesRemoteUpdate', {
    # Add required parameters here
})