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-design | Type: Application | PCID required: Yes

Tools

ToolDescription
penpot_design_clone_templateClone into the specified project the template by its id.
penpot_design_create_filePOST create-file
penpot_design_create_file_snapshotPOST create-file-snapshot
penpot_design_create_projectPOST create-project
penpot_design_delete_filePOST delete-file
penpot_design_delete_file_snapshotPOST delete-file-snapshot
penpot_design_delete_projectPOST delete-project
penpot_design_duplicate_fileDuplicate a single file in the same team.
penpot_design_duplicate_projectDuplicate an entire project with all the files
penpot_design_get_all_projectsGET get-all-projects
penpot_design_get_fileRetrieve a file by its ID. Only authenticated users.
penpot_design_get_file_infoRetrieve minimal file info by its ID.
penpot_design_get_file_librariesGet libraries used by the specified file.
penpot_design_get_file_snapshotsPOST get-file-snapshots
penpot_design_get_file_summaryRetrieve a file summary by its ID. Only authenticated users.
penpot_design_get_library_file_referencesReturns all the file references that use specified file (library) id.
penpot_design_get_library_usageGets the number of files that use the specified library.
penpot_design_get_pageRetrieves the page data from file and returns it. If no page-id is specified, the first page will be returned. If object-id is specified, only that object and its children will be returned in the page objects data structure. If you specify the object-id, the page-id parameter becomes mandatory. Mainly used for rendering purposes on the exporter. It does not accepts client features.
penpot_design_get_projectPOST get-project
penpot_design_get_project_filesGet all files for the specified project.
penpot_design_get_projectsPOST get-projects
penpot_design_get_team_deleted_filesPOST get-team-deleted-files
penpot_design_get_team_recent_filesPOST get-team-recent-files
penpot_design_get_team_shared_filesGet all file (libraries) for the specified team.
penpot_design_has_file_librariesChecks if the file has libraries. Returns a boolean
penpot_design_ignore_file_library_sync_statusIgnore updates in linked files
penpot_design_link_file_to_libraryLink a file to a library. Returns the recursive list of libraries used by that library
penpot_design_lock_file_snapshotPOST lock-file-snapshot
penpot_design_move_filesMove a set of files from one project to other.
penpot_design_move_projectMove projects between teams
penpot_design_permanently_delete_team_filesMark the specified files to be deleted immediatelly on the specified team. The team-id on params will be used to filter and check writable permissons on team.
penpot_design_rename_filePOST rename-file
penpot_design_rename_projectPOST rename-project
penpot_design_restore_deleted_team_filesRemoves the deletion mark from the specified files (and respective projects) on the specified team.
penpot_design_restore_file_snapshotPOST restore-file-snapshot
penpot_design_search_filesPOST search-files
penpot_design_set_file_sharedPOST set-file-shared
penpot_design_unlink_file_from_libraryPOST unlink-file-from-library
penpot_design_unlock_file_snapshotPOST unlock-file-snapshot
penpot_design_update_filePOST update-file
penpot_design_update_file_library_sync_statusUpdate the synchronization status of a file->library link
penpot_design_update_file_snapshotPOST update-file-snapshot
penpot_design_update_project_pinPOST update-project-pin

penpot_design_clone_template

Clone into the specified project the template by its id. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesUUID formatted string
templateIdstringYesstring

penpot_design_create_file

POST create-file Parameters:
ParameterTypeRequiredDefaultDescription
featuresstring[]NoSet of Strings
idstringNoUUID formatted string
isSharedbooleanNoboolean
namestringYesThe name value
projectIdstringYesUUID formatted string

penpot_design_create_file_snapshot

POST create-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
labelstringNoThe label value

penpot_design_create_project

POST create-project Parameters:
ParameterTypeRequiredDefaultDescription
idstringNoUUID formatted string
namestringYesThe name value
teamIdstringYesUUID formatted string

penpot_design_delete_file

POST delete-file Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_delete_file_snapshot

POST delete-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_delete_project

POST delete-project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_duplicate_file

Duplicate a single file in the same team. Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
namestringNoThe name value

penpot_design_duplicate_project

Duplicate an entire project with all the files Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoThe name value
projectIdstringYesUUID formatted string

penpot_design_get_all_projects

GET get-all-projects

penpot_design_get_file

Retrieve a file by its ID. Only authenticated users. Parameters:
ParameterTypeRequiredDefaultDescription
featuresstring[]NoSet of Strings
idstringYesUUID formatted string

penpot_design_get_file_info

Retrieve minimal file info by its ID. Parameters:
ParameterTypeRequiredDefaultDescription
featuresstring[]NoSet of Strings
idstringYesUUID formatted string

penpot_design_get_file_libraries

Get libraries used by the specified file. Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string

penpot_design_get_file_snapshots

POST get-file-snapshots Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string

penpot_design_get_file_summary

Retrieve a file summary by its ID. Only authenticated users. Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_get_library_file_references

Returns all the file references that use specified file (library) id. Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string

penpot_design_get_library_usage

Gets the number of files that use the specified library. Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string

penpot_design_get_page

Retrieves the page data from file and returns it. If no page-id is specified, the first page will be returned. If object-id is specified, only that object and its children will be returned in the page objects data structure. If you specify the object-id, the page-id parameter becomes mandatory. Mainly used for rendering purposes on the exporter. It does not accepts client features. Parameters:
ParameterTypeRequiredDefaultDescription
featuresstring[]NoSet of Strings
fileIdstringYesUUID formatted string
objectIdstring[]NoSet of Strings
pageIdstringNoUUID formatted string
shareIdstringNoUUID formatted string

penpot_design_get_project

POST get-project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_get_project_files

Get all files for the specified project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesUUID formatted string

penpot_design_get_projects

POST get-projects Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_design_get_team_deleted_files

POST get-team-deleted-files Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_design_get_team_recent_files

POST get-team-recent-files Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_design_get_team_shared_files

Get all file (libraries) for the specified team. Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringYesUUID formatted string

penpot_design_has_file_libraries

Checks if the file has libraries. Returns a boolean Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string

penpot_design_ignore_file_library_sync_status

Ignore updates in linked files Parameters:
ParameterTypeRequiredDefaultDescription
datestringYesThe date value
fileIdstringYesUUID formatted string

Link a file to a library. Returns the recursive list of libraries used by that library Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
libraryIdstringYesUUID formatted string

penpot_design_lock_file_snapshot

POST lock-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_move_files

Move a set of files from one project to other. Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesSet of Strings
projectIdstringYesUUID formatted string

penpot_design_move_project

Move projects between teams Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesUUID formatted string
teamIdstringYesUUID formatted string

penpot_design_permanently_delete_team_files

Mark the specified files to be deleted immediatelly on the specified team. The team-id on params will be used to filter and check writable permissons on team. Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesSet of Strings
teamIdstringYesUUID formatted string

penpot_design_rename_file

POST rename-file Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
namestringYesThe name value

penpot_design_rename_project

POST rename-project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
namestringYesThe name value

penpot_design_restore_deleted_team_files

Removes the deletion mark from the specified files (and respective projects) on the specified team. Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesSet of Strings
teamIdstringYesUUID formatted string

penpot_design_restore_file_snapshot

POST restore-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
idstringYesUUID formatted string

penpot_design_search_files

POST search-files Parameters:
ParameterTypeRequiredDefaultDescription
searchTermstringNoSearch term to filter results
teamIdstringYesUUID formatted string

penpot_design_set_file_shared

POST set-file-shared Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
isSharedbooleanYesboolean

POST unlink-file-from-library Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
libraryIdstringYesUUID formatted string

penpot_design_unlock_file_snapshot

POST unlock-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string

penpot_design_update_file

POST update-file Parameters:
ParameterTypeRequiredDefaultDescription
changesany[]NoThe changes value
changesWithMetadataobject[]NoChanges With Metadata
featuresstring[]NoSet of Strings
idstringYesUUID formatted string
revnintegerYesinteger
sessionIdstringYesUUID formatted string
skipValidatebooleanNoboolean
vernintegerYesinteger

penpot_design_update_file_library_sync_status

Update the synchronization status of a file->library link Parameters:
ParameterTypeRequiredDefaultDescription
fileIdstringYesUUID formatted string
libraryIdstringYesUUID formatted string

penpot_design_update_file_snapshot

POST update-file-snapshot Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
labelstringYesnot whitespace string

penpot_design_update_project_pin

POST update-project-pin Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUUID formatted string
isPinnedbooleanYesboolean
teamIdstringYesUUID formatted string