Operations 8
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I find the Docs in my ClickUp Workspace?”
“Can I search for Docs created by a specific person or under a particular parent?”
Tell an agent
Search Docs in Workspace {workspace_id}.
Find Docs in Workspace {workspace_id} created by user {creator}.
Ask an LLM
“How do I create a new Doc in a Workspace?”
“Can I set a Doc's visibility and parent location when I create it?”
Tell an agent
Create a Doc named {name} in Workspace {workspace_id}.
Create a {visibility} Doc called {name} under {parent} in Workspace {workspace_id}.
Ask an LLM
“What details can I get about a single Doc?”
“Can I look up a Doc by its ID?”
Tell an agent
Get Doc {doc_id} in Workspace {workspace_id}.
Show information about Doc {doc_id} in Workspace {workspace_id}.
GET
/api/v3/workspaces/{workspace_id}/docs/{doc_id}/page_listing
Get a Doc's page outline · Fetch PageListing for a Doc
#
Ask an LLM
“How can I see the structure of pages in a Doc without their content?”
“Can I limit how deep the page listing goes?”
Tell an agent
Get the page listing for Doc {doc_id} in Workspace {workspace_id}.
Show the page tree of Doc {doc_id} in Workspace {workspace_id} to depth {max_page_depth}.
GET
/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages
Fetch all pages of a Doc with content · Fetch Pages belonging to a Doc
#
Ask an LLM
“How do I pull every page of a Doc along with its content?”
“Can I get a Doc's pages back as markdown?”
Tell an agent
Fetch all pages of Doc {doc_id} in Workspace {workspace_id}.
Get the pages of Doc {doc_id} in Workspace {workspace_id} in {content_format} format.
Ask an LLM
“How do I add a new page to an existing Doc?”
“Can I create a sub-page under another page in a Doc?”
Tell an agent
Create page {name} in Doc {doc_id} of Workspace {workspace_id}.
Add a sub-page {name} under page {parent_page_id} in Doc {doc_id}, Workspace {workspace_id}, with content {content}.
GET
/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}
Get a single page from a Doc · Get page
#
Ask an LLM
“How do I read one specific page of a Doc?”
“Will a Doc page look exactly the same when exported as markdown?”
Tell an agent
Get page {page_id} of Doc {doc_id} in Workspace {workspace_id}.
Read page {page_id} in Doc {doc_id} of Workspace {workspace_id} as {content_format}.
PUT
/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}
Edit a page in a Doc · Edit a Page
#
Ask an LLM
“Can I append to a Doc page instead of replacing its content?”
“How do I rename a page inside a Doc?”
Tell an agent
Rename page {page_id} in Doc {doc_id}, Workspace {workspace_id}, to {name}.
Update page {page_id} of Doc {doc_id} in Workspace {workspace_id} with {content} using edit mode {content_edit_mode}.