Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /penpot-collaboration | Type: Application | PCID required: Yes

Tools

ToolDescription
penpot_collaboration_create_commentPOST create-comment
penpot_collaboration_create_comment_threadPOST create-comment-thread
penpot_collaboration_create_share_linkCreates a share-link object. Share links are resources that allows external users access to specific pages of a file with specific permissions (who-comment and who-inspect).
penpot_collaboration_create_webhookPOST create-webhook
penpot_collaboration_delete_commentPOST delete-comment
penpot_collaboration_delete_comment_threadPOST delete-comment-thread
penpot_collaboration_delete_share_linkPOST delete-share-link
penpot_collaboration_delete_webhookPOST delete-webhook
penpot_collaboration_get_comment_threadPOST get-comment-thread
penpot_collaboration_get_comment_threadsPOST get-comment-threads
penpot_collaboration_get_commentsPOST get-comments
penpot_collaboration_get_profiles_for_file_commentsRetrieves a list of profiles with limited set of properties of all participants on comment threads of the file.
penpot_collaboration_get_unread_comment_threadsPOST get-unread-comment-threads
penpot_collaboration_get_webhooksPOST get-webhooks
penpot_collaboration_mark_all_threads_as_readPOST mark-all-threads-as-read
penpot_collaboration_update_commentPOST update-comment
penpot_collaboration_update_comment_threadPOST update-comment-thread
penpot_collaboration_update_comment_thread_framePOST update-comment-thread-frame
penpot_collaboration_update_comment_thread_positionPOST update-comment-thread-position
penpot_collaboration_update_comment_thread_statusPOST update-comment-thread-status
penpot_collaboration_update_webhookPOST update-webhook

penpot_collaboration_create_comment

POST create-comment Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe content value
mentionsstring[]NoSet of Strings
shareIdstringNoUUID formatted string
threadIdstringYesUUID formatted string

penpot_collaboration_create_comment_thread

POST create-comment-thread Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe content value
fileIdstringYesUUID formatted string
frameIdstringYesUUID formatted string
mentionsstring[]NoSet of Strings
pageIdstringYesUUID formatted string
positionobjectYesA 2D point with x and y coordinates
shareIdstringNoUUID formatted string

Creates a share-link object. Share links are resources that allows external users access to specific pages of a file with specific permissions (who-comment and who-inspect). Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
pagesstring[]YesThe pages value
whoCommentstringYesWho Comment
whoInspectstringYesWho Inspect

penpot_collaboration_create_webhook

POST create-webhook Parameters:
ParameterTypeRequiredDefaultDescription
mtypestringYesThe mtype value
teamIdstringYesUUID formatted string
uristringYesURI formatted string

penpot_collaboration_delete_comment

POST delete-comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
shareIdstringNoUUID formatted string

penpot_collaboration_delete_comment_thread

POST delete-comment-thread Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
shareIdstringNoUUID formatted string

POST delete-share-link Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_collaboration_delete_webhook

POST delete-webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_collaboration_get_comment_thread

POST get-comment-thread Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
idstringYesUUID formatted string
shareIdstringNoUUID formatted string

penpot_collaboration_get_comment_threads

POST get-comment-threads Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringNoUUID formatted string
shareIdstringNoUUID formatted string
teamIdstringNoUUID formatted string

penpot_collaboration_get_comments

POST get-comments Parameters:
ParameterTypeRequiredDefaultDescription
shareIdstringNoUUID formatted string
threadIdstringYesUUID formatted string

penpot_collaboration_get_profiles_for_file_comments

Retrieves a list of profiles with limited set of properties of all participants on comment threads of the file. Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
shareIdstringNoUUID formatted string

penpot_collaboration_get_unread_comment_threads

POST get-unread-comment-threads Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_collaboration_get_webhooks

POST get-webhooks Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_collaboration_mark_all_threads_as_read

POST mark-all-threads-as-read Parameters:
ParameterTypeRequiredDefaultDescription
threadsstring[]YesThe threads value

penpot_collaboration_update_comment

POST update-comment Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe content value
idstringYesUUID formatted string
mentionsstring[]NoSet of Strings
shareIdstringNoUUID formatted string

penpot_collaboration_update_comment_thread

POST update-comment-thread Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
isResolvedbooleanYesIs Resolved
shareIdstringNoUUID formatted string

penpot_collaboration_update_comment_thread_frame

POST update-comment-thread-frame Parameters:
ParameterTypeRequiredDefaultDescription
frameIdstringYesUUID formatted string
idstringYesUUID formatted string
shareIdstringNoUUID formatted string

penpot_collaboration_update_comment_thread_position

POST update-comment-thread-position Parameters:
ParameterTypeRequiredDefaultDescription
frameIdstringYesUUID formatted string
idstringYesUUID formatted string
positionobjectYesA 2D point with x and y coordinates
shareIdstringNoUUID formatted string

penpot_collaboration_update_comment_thread_status

POST update-comment-thread-status Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
shareIdstringNoUUID formatted string

penpot_collaboration_update_webhook

POST update-webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
isActivebooleanYesboolean
mtypestringYesThe mtype value
uristringYesURI formatted string