Import a KiCad project
import_kicad_projectBring an existing KiCad project in as a board workspace: the project folder as a ZIP (the .kicad_pcb, .kicad_pro, schematics, footprint and 3D-model folders), base64-encoded, up to about 18 MB zipped. The CLI does this with koppar import <folder>. Or from_design_id: the KiCad project of a design the pipeline built (its board, rules, schematics and custom footprints) opened as a workspace, to change the design rules, place and route it with the board tools and put the result back with upload_board (workspace_id). Returns the design_id the board tools take and a first get_board_info.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brief | No | A note for the design record. No tool reads it: what to keep, widths and layers go in the options of set_design_rules and route_board. | |
| title | No | ||
| board_file | No | Which .kicad_pcb at the top of the project, when there are several. | |
| session_id | No | The project (web session) a new revision of this board goes into: the session_id the first import returned. Without it, an import whose title matches a project you opened before joins that project, so revisions of one board stay together in the user's list. | |
| zip_base64 | No | The zipped project folder, base64. | |
| new_project | No | Start a new project even when one with this title exists. | |
| from_design_id | No | A design of yours with a board (start_board or upload_board): its KiCad project becomes the workspace. Instead of zip_base64. |