---
agentTools:
  projectIndex: https://floorplanner.readme.io/llms.txt
---

# Create Project

Create a project

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "description": "This is the API documentation for Floorplanner",
    "version": "2.0",
    "title": "Floorplanner",
    "termsOfService": "https://floorplanner.com/terms",
    "contact": {
      "email": "support@floorplanner.com"
    },
    "license": {
      "name": "Copyright Floorplanner"
    }
  },
  "servers": [
    {
      "url": "https://floorplanner.com/api/v2/",
      "description": "Production"
    },
    {
      "url": "https://floorplanner.dev/api/v2/",
      "description": "Staging / Sandbox"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/projects.json": {
      "post": {
        "tags": [
          "Project"
        ],
        "operationId": "createProject",
        "summary": "Create Project",
        "description": "Create a project",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "project": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The name of the project"
                      },
                      "description": {
                        "type": "string",
                        "description": "Project description"
                      },
                      "external_identifier": {
                        "type": "string",
                        "description": "External identifier which must start with a character, not a number and must be unique per project"
                      },
                      "creator_email": {
                        "type": "string",
                        "description": "Add permissions to a project for user with email. (Address must be present in our database)"
                      },
                      "enable_vr_tour": {
                        "type": "boolean",
                        "description": "Automatically adds 3D tour to the project (This requires a credit transaction)"
                      },
                      "public": {
                        "type": "boolean",
                        "description": "Sets the project public or private"
                      },
                      "labelings": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "description": "A label you want to attach to a project"
                        }
                      },
                      "project_template_attributes": {
                        "type": "object",
                        "properties": {
                          "template_id": {
                            "type": "number",
                            "description": "The ID of the template you would like to use"
                          }
                        }
                      },
                      "floors_attributes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "The name of the floor"
                            },
                            "level": {
                              "type": "number",
                              "description": "The floor level"
                            },
                            "height": {
                              "type": "number",
                              "description": "Height of the floor"
                            },
                            "drawing_attributes": {
                              "type": "object",
                              "properties": {
                                "remote_filename_url": {
                                  "type": "string",
                                  "description": "URL to the background image"
                                }
                              }
                            },
                            "designs_attributes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "The name of the design"
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "location_attributes": {
                        "type": "object",
                        "properties": {
                          "city": {
                            "type": "string",
                            "description": "The city in which the project is located"
                          },
                          "country": {
                            "type": "string",
                            "description": "The country in which the project is located"
                          },
                          "address": {
                            "type": "string",
                            "description": "The address at which the project is located"
                          },
                          "zipcode": {
                            "type": "string",
                            "description": "The zipcode in which the project is located"
                          },
                          "building": {
                            "type": "string",
                            "description": "The building in which the project is located"
                          },
                          "state": {
                            "type": "string",
                            "description": "The state in which the project is located"
                          },
                          "coords": {
                            "type": "string",
                            "description": "The longitude and latitude at which the project is located, separated by a comma"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/project"
                }
              }
            }
          },
          "403": {
            "description": "Access denied"
          },
          "404": {
            "description": "Project not found"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "project": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "user_id": {
            "type": "number"
          },
          "level_id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "project_url": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "enable_autosave": {
            "type": "boolean"
          },
          "external_identifier": {
            "type": "string"
          },
          "exported_at": {
            "type": "string",
            "format": "date-time"
          },
          "public": {
            "type": "boolean"
          },
          "floors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/floor_with_designs"
            }
          }
        }
      },
      "floor_with_designs": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "project_id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "level": {
                "type": "number"
              },
              "height": {
                "type": "number"
              },
              "created_at": {
                "type": "string",
                "format": "date-time"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "designs": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/design"
                }
              }
            }
          }
        ]
      },
      "design": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "floor_id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "thumb_2d_generated_at": {
            "type": "string",
            "format": "date-time"
          },
          "thumb_3d_generated_at": {
            "type": "string",
            "format": "date-time"
          },
          "user_id": {
            "type": "number"
          },
          "design_type": {
            "type": "string",
            "enum": [
              "save",
              "save_as",
              "send_a_friend",
              "image_export",
              "save_and_mail",
              "bookmark"
            ]
          },
          "design_hash": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 96,
      "1": 212,
      "2": 89,
      "3": 57,
      "4": 36,
      "5": 241,
      "6": 215,
      "7": 3,
      "8": 91,
      "9": 209,
      "10": 88,
      "11": 227
    }
  }
}
```