Skip to main content
9 tools. Each one is also a REST route and a CLI command, from the same definition: the same input, the same output, the same errors.

get_file_store_status

Whether this server has somewhere to put a file. configured means the deployment has a blob store, so an upload route answers with a token rather than a refusal. A picture or an attachment can be offered only when it is true.

Input

This tool takes no arguments.

Output

Example

list_comments

List the comments on an entity. Returns the comments on a task, project or area, oldest first. Attachments are not exposed by the API: only their count is.

Input

Output

Example

list_files

List an entity’s attachments. The links attached to a task, project or area, newest first.

Input

Output

Example

list_inbox_comments

Others’ comments across your workspace. Feeds the Inbox: the most recent comments left by someone else on your tasks, projects and areas: newest first, each with the entity it targets. Your own comments never appear here; they live in their threads.

Input

Output

Example

add_comment

Add a comment. Posts a comment on a task, project or area. The first link in the text is unfurled in the background (OpenGraph preview) without blocking the response. On a shared task the commenter role is enough.

Input

Output

Example

Attach a link. Attaches an external link to a task, project or area. A minimal preview (the address and the site it points at) is stored immediately; the rest of the card is filled in out of band, so a site that refuses the request costs nothing.

Input

Output

Example

delete_comment

Delete a comment. Removes a comment and its attachments. The author may always delete their own; anyone else needs to own the entity the thread hangs off. This deletion is not reversible.

Input

Output

Example

remove_file

Remove an attachment. Detaches a link. Nothing else is touched.

Input

Output

Example

update_comment

Edit a comment. Rewrites the text of a comment. Only its author may edit it: owning the task, project or area the thread hangs off is not enough, because a thread is a record of who said what.

Input

Output

Example