Shade icon

Shade

Interact with Shade API

Asset → Comment

AI-generated

Summary

Add a comment to a specified asset within a chosen drive and optionally specify whether the comment is public.

Inputs

  • Workspace — The workspace to work in, selectable from a list or by ID.
  • Drive (required) — The drive where the asset resides, selectable from a list or by ID.
  • Asset ID (required) — The unique identifier of the asset to comment on.
  • Comment (required) — The text content of the comment to add to the asset.
  • Public — Boolean flag indicating whether the comment should be publicly visible; defaults to true.

Output shape

a JSON object representing the newly created comment returned by the Shade API

The output contains the API response for the created comment, including its details such as content and visibility. If the operation fails, an error will be raised.

Examples

Example 1: Add a comment to an asset

Set the Workspace and Drive containing the asset, provide the Asset ID, enter the comment text, and select if the comment should be public.

Links

Discussion