/penpot-design | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
penpot_design_clone_template | Clone into the specified project the template by its id. |
penpot_design_create_file | POST create-file |
penpot_design_create_file_snapshot | POST create-file-snapshot |
penpot_design_create_project | POST create-project |
penpot_design_delete_file | POST delete-file |
penpot_design_delete_file_snapshot | POST delete-file-snapshot |
penpot_design_delete_project | POST delete-project |
penpot_design_duplicate_file | Duplicate a single file in the same team. |
penpot_design_duplicate_project | Duplicate an entire project with all the files |
penpot_design_get_all_projects | GET get-all-projects |
penpot_design_get_file | Retrieve a file by its ID. Only authenticated users. |
penpot_design_get_file_info | Retrieve minimal file info by its ID. |
penpot_design_get_file_libraries | Get libraries used by the specified file. |
penpot_design_get_file_snapshots | POST get-file-snapshots |
penpot_design_get_file_summary | Retrieve a file summary by its ID. Only authenticated users. |
penpot_design_get_library_file_references | Returns all the file references that use specified file (library) id. |
penpot_design_get_library_usage | Gets the number of files that use the specified library. |
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. |
penpot_design_get_project | POST get-project |
penpot_design_get_project_files | Get all files for the specified project. |
penpot_design_get_projects | POST get-projects |
penpot_design_get_team_deleted_files | POST get-team-deleted-files |
penpot_design_get_team_recent_files | POST get-team-recent-files |
penpot_design_get_team_shared_files | Get all file (libraries) for the specified team. |
penpot_design_has_file_libraries | Checks if the file has libraries. Returns a boolean |
penpot_design_ignore_file_library_sync_status | Ignore updates in linked files |
penpot_design_link_file_to_library | Link a file to a library. Returns the recursive list of libraries used by that library |
penpot_design_lock_file_snapshot | POST lock-file-snapshot |
penpot_design_move_files | Move a set of files from one project to other. |
penpot_design_move_project | Move projects between teams |
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. |
penpot_design_rename_file | POST rename-file |
penpot_design_rename_project | POST rename-project |
penpot_design_restore_deleted_team_files | Removes the deletion mark from the specified files (and respective projects) on the specified team. |
penpot_design_restore_file_snapshot | POST restore-file-snapshot |
penpot_design_search_files | POST search-files |
penpot_design_set_file_shared | POST set-file-shared |
penpot_design_unlink_file_from_library | POST unlink-file-from-library |
penpot_design_unlock_file_snapshot | POST unlock-file-snapshot |
penpot_design_update_file | POST update-file |
penpot_design_update_file_library_sync_status | Update the synchronization status of a file->library link |
penpot_design_update_file_snapshot | POST update-file-snapshot |
penpot_design_update_project_pin | POST update-project-pin |
penpot_design_clone_template
Clone into the specified project the template by its id. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | UUID formatted string |
templateId | string | Yes | — | string |
penpot_design_create_file
POST create-file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
features | string[] | No | — | Set of Strings |
id | string | No | — | UUID formatted string |
isShared | boolean | No | — | boolean |
name | string | Yes | — | The name value |
projectId | string | Yes | — | UUID formatted string |
penpot_design_create_file_snapshot
POST create-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
label | string | No | — | The label value |
penpot_design_create_project
POST create-project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | UUID formatted string |
name | string | Yes | — | The name value |
teamId | string | Yes | — | UUID formatted string |
penpot_design_delete_file
POST delete-file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_delete_file_snapshot
POST delete-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_delete_project
POST delete-project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_duplicate_file
Duplicate a single file in the same team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
name | string | No | — | The name value |
penpot_design_duplicate_project
Duplicate an entire project with all the files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name value |
projectId | string | Yes | — | UUID formatted string |
penpot_design_get_all_projects
GET get-all-projectspenpot_design_get_file
Retrieve a file by its ID. Only authenticated users. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
features | string[] | No | — | Set of Strings |
id | string | Yes | — | UUID formatted string |
penpot_design_get_file_info
Retrieve minimal file info by its ID. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
features | string[] | No | — | Set of Strings |
id | string | Yes | — | UUID formatted string |
penpot_design_get_file_libraries
Get libraries used by the specified file. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
penpot_design_get_file_snapshots
POST get-file-snapshots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
penpot_design_get_file_summary
Retrieve a file summary by its ID. Only authenticated users. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_get_library_file_references
Returns all the file references that use specified file (library) id. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
penpot_design_get_library_usage
Gets the number of files that use the specified library. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
features | string[] | No | — | Set of Strings |
fileId | string | Yes | — | UUID formatted string |
objectId | string[] | No | — | Set of Strings |
pageId | string | No | — | UUID formatted string |
shareId | string | No | — | UUID formatted string |
penpot_design_get_project
POST get-project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_get_project_files
Get all files for the specified project. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | UUID formatted string |
penpot_design_get_projects
POST get-projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | Yes | — | UUID formatted string |
penpot_design_get_team_deleted_files
POST get-team-deleted-files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | Yes | — | UUID formatted string |
penpot_design_get_team_recent_files
POST get-team-recent-files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | Yes | — | UUID formatted string |
penpot_design_get_team_shared_files
Get all file (libraries) for the specified team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | Yes | — | UUID formatted string |
penpot_design_has_file_libraries
Checks if the file has libraries. Returns a boolean Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
penpot_design_ignore_file_library_sync_status
Ignore updates in linked files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | Yes | — | The date value |
fileId | string | Yes | — | UUID formatted string |
penpot_design_link_file_to_library
Link a file to a library. Returns the recursive list of libraries used by that library Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
libraryId | string | Yes | — | UUID formatted string |
penpot_design_lock_file_snapshot
POST lock-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_move_files
Move a set of files from one project to other. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | Set of Strings |
projectId | string | Yes | — | UUID formatted string |
penpot_design_move_project
Move projects between teams Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | string | Yes | — | UUID formatted string |
teamId | string | Yes | — | UUID 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | Set of Strings |
teamId | string | Yes | — | UUID formatted string |
penpot_design_rename_file
POST rename-file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
name | string | Yes | — | The name value |
penpot_design_rename_project
POST rename-project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
name | string | Yes | — | The name value |
penpot_design_restore_deleted_team_files
Removes the deletion mark from the specified files (and respective projects) on the specified team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | Set of Strings |
teamId | string | Yes | — | UUID formatted string |
penpot_design_restore_file_snapshot
POST restore-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
id | string | Yes | — | UUID formatted string |
penpot_design_search_files
POST search-files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
searchTerm | string | No | — | Search term to filter results |
teamId | string | Yes | — | UUID formatted string |
penpot_design_set_file_shared
POST set-file-shared Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
isShared | boolean | Yes | — | boolean |
penpot_design_unlink_file_from_library
POST unlink-file-from-library Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
libraryId | string | Yes | — | UUID formatted string |
penpot_design_unlock_file_snapshot
POST unlock-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
penpot_design_update_file
POST update-file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
changes | any[] | No | — | The changes value |
changesWithMetadata | object[] | No | — | Changes With Metadata |
features | string[] | No | — | Set of Strings |
id | string | Yes | — | UUID formatted string |
revn | integer | Yes | — | integer |
sessionId | string | Yes | — | UUID formatted string |
skipValidate | boolean | No | — | boolean |
vern | integer | Yes | — | integer |
penpot_design_update_file_library_sync_status
Update the synchronization status of a file->library link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | string | Yes | — | UUID formatted string |
libraryId | string | Yes | — | UUID formatted string |
penpot_design_update_file_snapshot
POST update-file-snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
label | string | Yes | — | not whitespace string |
penpot_design_update_project_pin
POST update-project-pin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | UUID formatted string |
isPinned | boolean | Yes | — | boolean |
teamId | string | Yes | — | UUID formatted string |

