Planner 5D: Design & Planning

Use this when the user wants progress or the saved project link for a Planner 5D recognition job already started with start_floor_plan_recognition. Requires its exact job_id and the same connected account. Do not use to search all Planner 5D projects, open an arbitrary project ID, start recognition, or modify a project. Never invent a job_id. Waits up to 20 seconds and returns immediately when finished. For recognizing or publishing, call again without an extra delay. For ready, show project_url as a clickable link; the project is already saved. For failed, stop. If publication_attempted is true on failure, creation is unconfirmed: ask the user to check Planner 5D before starting another job. An unavailable job must not be automatically restarted.

get_floor_plan_recognition

Use this when the user wants to convert an attached floor plan image into a new editable 2D/3D project in their connected Planner 5D account. Accepts PNG, JPEG or WebP attachments up to 16 MiB. Do not use for general design advice, room photos, text-to-plan generation, PDF/CAD files, editing an existing project, or checking an existing job. If no supported image is attached, ask for one; never invent attachment fields. Use scale_hint for a readable or user-provided dimension with clear endpoints, unless the user requests automatic scale. Otherwise omit it and explain that automatic scale is being used. Never estimate dimensions from typical objects. Each call starts a new job and automatically saves a new project; do not restart just to check progress. Use get_floor_plan_recognition with the returned job_id until ready or failed. When ready, show project_url as a clickable link; saving is already complete.

start_floor_plan_recognition