{"openapi":"3.1.0","info":{"title":"BIM Studio API","version":"1.0.0","description":"Projeto de edificações (BIM) no navegador, com as normas brasileiras: arquitetura, estrutura (NBR 6118/8800/7190), instalações (NBR 5410/5626/8160), orçamento, conferência de normas e documentos (pranchas, memoriais, IFC, DXF). Cada ferramenta da interface também roda aqui. English: Brazilian building-design (BIM) app; every UI tool is exposed as an API call over a saved project. Auth: Bearer API key (plans Profissional/Escritório). Docs: https://bimstudio.com.br/manual/#api"},"servers":[{"url":"https://bimstudio.com.br"}],"components":{"securitySchemes":{"chave":{"type":"http","scheme":"bearer","description":"chave bim_… criada em Conta → API e integrações"}}},"paths":{"/api/v1":{"get":{"operationId":"informacoes","summary":"Informações da API (público)","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/ferramentas":{"get":{"operationId":"listarFerramentas","summary":"Catálogo público: nome, descrição, esquema de entrada e se roda sem tela","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/modelos":{"get":{"operationId":"listarModelos","summary":"Modelos prontos para criar projeto (público)","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/projetos":{"get":{"operationId":"listarProjetos","summary":"Projetos da conta","security":[{"chave":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}},"post":{"operationId":"criarProjeto","summary":"Cria um projeto: em branco, de um modelo, ou com o conteúdo de um .bim3.json","security":[{"chave":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["nome"],"properties":{"nome":{"type":"string"},"modelo":{"type":"string","description":"id de GET /api/v1/modelos"},"projeto":{"type":"object"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/projetos/{id}":{"get":{"operationId":"lerProjeto","summary":"O projeto inteiro (conteúdo do .bim3.json)","security":[{"chave":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"id do projeto (GET /api/v1/projetos)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/v1/projetos/{id}/ferramentas/{nome}":{"post":{"operationId":"rodarFerramenta","summary":"Roda UMA ferramenta no projeto; se ela mudar o projeto, grava","security":[{"chave":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"id do projeto (GET /api/v1/projetos)"},{"name":"nome","in":"path","required":true,"schema":{"type":"string","enum":["listar_claraboias","distribuir_claraboias","inserir_claraboia","editar_claraboia","remover_claraboia","desvincular_produto_claraboia","desvincular_produto_esquadria","reencaixar_claraboia","resumo_projeto","listar_pavimentos","girar_planta","selecionar_pavimento","criar_pavimento","remover_pavimento","renomear_pavimento","definir_pe_direito","definir_nome_projeto","salvar_projeto","gerar_escadas","criar_via","listar_vias","remover_via","criar_arrimo","listar_arrimos","remover_arrimo","criar_ponte","listar_pontes","remover_ponte","criar_silo","listar_silos","remover_silo","criar_reservatorio_elevado","listar_reservatorios_elevados","remover_reservatorio_elevado","criar_torre","listar_torres","remover_torre","listar_comodos","criar_comodo","renomear_comodo","remover_comodo","mover_comodo","redimensionar_comodo","listar_paredes","adicionar_abertura","definir_terreno","norte_do_projeto","estudo_solar","iluminancia_natural","zoneamento_do_lote","envelope_construtivo","lote_minimo","programa_cabivel","tabela_zoneamento_municipio","area_edificavel","definir_declive_terreno","adicionar_elemento","listar_elementos","estrutura","analise_fem","nucleo_rigido","analisar_laje","estrutura_aco","verificar_perfil_aco","dimensionar_viga_mista","dimensionar_aco","dimensionar_madeira","analise_sismica","gerar_eletrica","gerar_hidraulica","gerar_esgoto","definir_corte","definir_escala_pranchas","definir_uso_pavimento","lancar_luminarias","lancar_telecom","lancar_gas","lancar_ventilacao_esgoto","demarcar_estacionamento","aplicar_fachada_cortina","listar_ramais_agua","tracar_cano_agua","listar_ramais_esgoto","tracar_cano_esgoto","criar_condutor_pluvial","listar_condutores_pluviais","remover_condutor_pluvial","criar_aspersor","listar_aspersores","remover_aspersor","dimensionar_irrigacao","listar_produtos_fornecedor","orcar_materiais","criar_atividade","listar_atividades","vincular_comodos","simular_4d","listar_composicoes","definir_composicao","custo_5d","orcamento","rodar_clash","fechar_em_comodos","quadro_areas_12721","areas_unidades_12721","exportar_bcf","laudo_inspecao_predial","folha_eletrica","folha_hidraulica","folha_esgoto","folha_telecom","quadros_esquadrias","carga_termica","relatorio_obra","exportar_dxf_disciplina","dados_de_terceiro","comparar_preco_lojas","documento_arquitetonico","planta_cotada","cortes_fachadas","memorial_descritivo","pranchas_estrutura","estruturas_especiais","prancha_instalacoes","orcamento_analitico","gerar_folhas_arq","exportar_dxf","exportar_ifc","projeto_legal","gerar_caderno","gerar_folha","colocar_componente_detalhe","keynote","linework","parametro_global","filtro_vista","produto_fabricante","converter_importado","paredes_duplas","etapa_projeto","vazios_planta","registrar_anomalia","listar_anomalias","evoluir_anomalia","gerar_laudo_pericial","peca_parametrica","listar_elementos_estruturais","inserir_elemento_estrutural","listar_elementos_arquitetonicos","listar_elementos_eletricos","listar_elementos_hidraulicos","listar_elementos_infra","validar_compatibilizacao","gerar_modelo","normalizar_projeto","sugerir_completacoes","analisar_balancos","dimensionar_protendido","listar_tipos_telhado","definir_cobertura","estrutura_espacial_definir","estrutura_espacial_calcular","estrutura_espacial_otimizar","aplicar_tipo_telhado","desenhar_telhado","listar_telhado","ajustar_agua_telhado","criar_comodo_forma","inserir_detalhe","listar_detalhes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entrada":{"type":"object"},"pavimento":{"type":"integer"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"resultados":{"type":"array","items":{"type":"object","properties":{"ferramenta":{"type":"string"},"resultado":{}}}},"gravado":{"type":["object","null"],"description":"versão gravada no projeto da conta (null = nada mudou)"},"documentos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"html":{"type":"string"}}}},"arquivos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"tipo":{"type":"string"},"texto":{"type":"string"},"base64":{"type":"string"}}}},"avisos":{"type":"array","items":{}},"recusasDePlano":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/v1/projetos/{id}/executar":{"post":{"operationId":"executarEmLote","summary":"Várias ferramentas em sequência (até 50), gravando uma vez","security":[{"chave":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"id do projeto (GET /api/v1/projetos)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["chamadas"],"properties":{"chamadas":{"type":"array","maxItems":50,"items":{"type":"object","required":["ferramenta"],"properties":{"ferramenta":{"type":"string","enum":["listar_claraboias","distribuir_claraboias","inserir_claraboia","editar_claraboia","remover_claraboia","desvincular_produto_claraboia","desvincular_produto_esquadria","reencaixar_claraboia","resumo_projeto","listar_pavimentos","girar_planta","selecionar_pavimento","criar_pavimento","remover_pavimento","renomear_pavimento","definir_pe_direito","definir_nome_projeto","salvar_projeto","gerar_escadas","criar_via","listar_vias","remover_via","criar_arrimo","listar_arrimos","remover_arrimo","criar_ponte","listar_pontes","remover_ponte","criar_silo","listar_silos","remover_silo","criar_reservatorio_elevado","listar_reservatorios_elevados","remover_reservatorio_elevado","criar_torre","listar_torres","remover_torre","listar_comodos","criar_comodo","renomear_comodo","remover_comodo","mover_comodo","redimensionar_comodo","listar_paredes","adicionar_abertura","definir_terreno","norte_do_projeto","estudo_solar","iluminancia_natural","zoneamento_do_lote","envelope_construtivo","lote_minimo","programa_cabivel","tabela_zoneamento_municipio","area_edificavel","definir_declive_terreno","adicionar_elemento","listar_elementos","estrutura","analise_fem","nucleo_rigido","analisar_laje","estrutura_aco","verificar_perfil_aco","dimensionar_viga_mista","dimensionar_aco","dimensionar_madeira","analise_sismica","gerar_eletrica","gerar_hidraulica","gerar_esgoto","definir_corte","definir_escala_pranchas","definir_uso_pavimento","lancar_luminarias","lancar_telecom","lancar_gas","lancar_ventilacao_esgoto","demarcar_estacionamento","aplicar_fachada_cortina","listar_ramais_agua","tracar_cano_agua","listar_ramais_esgoto","tracar_cano_esgoto","criar_condutor_pluvial","listar_condutores_pluviais","remover_condutor_pluvial","criar_aspersor","listar_aspersores","remover_aspersor","dimensionar_irrigacao","listar_produtos_fornecedor","orcar_materiais","criar_atividade","listar_atividades","vincular_comodos","simular_4d","listar_composicoes","definir_composicao","custo_5d","orcamento","rodar_clash","fechar_em_comodos","quadro_areas_12721","areas_unidades_12721","exportar_bcf","laudo_inspecao_predial","folha_eletrica","folha_hidraulica","folha_esgoto","folha_telecom","quadros_esquadrias","carga_termica","relatorio_obra","exportar_dxf_disciplina","dados_de_terceiro","comparar_preco_lojas","documento_arquitetonico","planta_cotada","cortes_fachadas","memorial_descritivo","pranchas_estrutura","estruturas_especiais","prancha_instalacoes","orcamento_analitico","gerar_folhas_arq","exportar_dxf","exportar_ifc","projeto_legal","gerar_caderno","gerar_folha","colocar_componente_detalhe","keynote","linework","parametro_global","filtro_vista","produto_fabricante","converter_importado","paredes_duplas","etapa_projeto","vazios_planta","registrar_anomalia","listar_anomalias","evoluir_anomalia","gerar_laudo_pericial","peca_parametrica","listar_elementos_estruturais","inserir_elemento_estrutural","listar_elementos_arquitetonicos","listar_elementos_eletricos","listar_elementos_hidraulicos","listar_elementos_infra","validar_compatibilizacao","gerar_modelo","normalizar_projeto","sugerir_completacoes","analisar_balancos","dimensionar_protendido","listar_tipos_telhado","definir_cobertura","estrutura_espacial_definir","estrutura_espacial_calcular","estrutura_espacial_otimizar","aplicar_tipo_telhado","desenhar_telhado","listar_telhado","ajustar_agua_telhado","criar_comodo_forma","inserir_detalhe","listar_detalhes"]},"entrada":{"type":"object","description":"veja o esquema da ferramenta em GET /api/v1/ferramentas"}}}},"pavimento":{"type":"integer"},"pararNoErro":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"resultados":{"type":"array","items":{"type":"object","properties":{"ferramenta":{"type":"string"},"resultado":{}}}},"gravado":{"type":["object","null"],"description":"versão gravada no projeto da conta (null = nada mudou)"},"documentos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"html":{"type":"string"}}}},"arquivos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"tipo":{"type":"string"},"texto":{"type":"string"},"base64":{"type":"string"}}}},"avisos":{"type":"array","items":{}},"recusasDePlano":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/v1/executar":{"post":{"operationId":"executarSemConta","summary":"Sem guardar na conta: o projeto vai no pedido e volta alterado","security":[{"chave":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["projeto","chamadas"],"properties":{"projeto":{"type":"object"},"chamadas":{"type":"array","maxItems":50,"items":{"type":"object","required":["ferramenta"],"properties":{"ferramenta":{"type":"string","enum":["listar_claraboias","distribuir_claraboias","inserir_claraboia","editar_claraboia","remover_claraboia","desvincular_produto_claraboia","desvincular_produto_esquadria","reencaixar_claraboia","resumo_projeto","listar_pavimentos","girar_planta","selecionar_pavimento","criar_pavimento","remover_pavimento","renomear_pavimento","definir_pe_direito","definir_nome_projeto","salvar_projeto","gerar_escadas","criar_via","listar_vias","remover_via","criar_arrimo","listar_arrimos","remover_arrimo","criar_ponte","listar_pontes","remover_ponte","criar_silo","listar_silos","remover_silo","criar_reservatorio_elevado","listar_reservatorios_elevados","remover_reservatorio_elevado","criar_torre","listar_torres","remover_torre","listar_comodos","criar_comodo","renomear_comodo","remover_comodo","mover_comodo","redimensionar_comodo","listar_paredes","adicionar_abertura","definir_terreno","norte_do_projeto","estudo_solar","iluminancia_natural","zoneamento_do_lote","envelope_construtivo","lote_minimo","programa_cabivel","tabela_zoneamento_municipio","area_edificavel","definir_declive_terreno","adicionar_elemento","listar_elementos","estrutura","analise_fem","nucleo_rigido","analisar_laje","estrutura_aco","verificar_perfil_aco","dimensionar_viga_mista","dimensionar_aco","dimensionar_madeira","analise_sismica","gerar_eletrica","gerar_hidraulica","gerar_esgoto","definir_corte","definir_escala_pranchas","definir_uso_pavimento","lancar_luminarias","lancar_telecom","lancar_gas","lancar_ventilacao_esgoto","demarcar_estacionamento","aplicar_fachada_cortina","listar_ramais_agua","tracar_cano_agua","listar_ramais_esgoto","tracar_cano_esgoto","criar_condutor_pluvial","listar_condutores_pluviais","remover_condutor_pluvial","criar_aspersor","listar_aspersores","remover_aspersor","dimensionar_irrigacao","listar_produtos_fornecedor","orcar_materiais","criar_atividade","listar_atividades","vincular_comodos","simular_4d","listar_composicoes","definir_composicao","custo_5d","orcamento","rodar_clash","fechar_em_comodos","quadro_areas_12721","areas_unidades_12721","exportar_bcf","laudo_inspecao_predial","folha_eletrica","folha_hidraulica","folha_esgoto","folha_telecom","quadros_esquadrias","carga_termica","relatorio_obra","exportar_dxf_disciplina","dados_de_terceiro","comparar_preco_lojas","documento_arquitetonico","planta_cotada","cortes_fachadas","memorial_descritivo","pranchas_estrutura","estruturas_especiais","prancha_instalacoes","orcamento_analitico","gerar_folhas_arq","exportar_dxf","exportar_ifc","projeto_legal","gerar_caderno","gerar_folha","colocar_componente_detalhe","keynote","linework","parametro_global","filtro_vista","produto_fabricante","converter_importado","paredes_duplas","etapa_projeto","vazios_planta","registrar_anomalia","listar_anomalias","evoluir_anomalia","gerar_laudo_pericial","peca_parametrica","listar_elementos_estruturais","inserir_elemento_estrutural","listar_elementos_arquitetonicos","listar_elementos_eletricos","listar_elementos_hidraulicos","listar_elementos_infra","validar_compatibilizacao","gerar_modelo","normalizar_projeto","sugerir_completacoes","analisar_balancos","dimensionar_protendido","listar_tipos_telhado","definir_cobertura","estrutura_espacial_definir","estrutura_espacial_calcular","estrutura_espacial_otimizar","aplicar_tipo_telhado","desenhar_telhado","listar_telhado","ajustar_agua_telhado","criar_comodo_forma","inserir_detalhe","listar_detalhes"]},"entrada":{"type":"object","description":"veja o esquema da ferramenta em GET /api/v1/ferramentas"}}}},"pavimento":{"type":"integer"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"resultados":{"type":"array","items":{"type":"object","properties":{"ferramenta":{"type":"string"},"resultado":{}}}},"gravado":{"type":["object","null"],"description":"versão gravada no projeto da conta (null = nada mudou)"},"documentos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"html":{"type":"string"}}}},"arquivos":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"tipo":{"type":"string"},"texto":{"type":"string"},"base64":{"type":"string"}}}},"avisos":{"type":"array","items":{}},"recusasDePlano":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/mcp":{"post":{"operationId":"mcp","summary":"Model Context Protocol (JSON-RPC 2.0 por HTTP) para agentes de IA","security":[{"chave":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}},"202":{"description":"notificação aceita"}}}}}}