Перейти к содержимому

4.2 HTTP API

342 маршрутов в 42 разделах, OpenAPI 3.1.0. Список снят с работающего бэкенда; машиночитаемое описание тот же сервер отдаёт по /api/openapi.json, интерактивную страницу — по /api/docs. Что из этого предназначено внешней системе, с текстами отказов, — на странице «API и интеграция».

Токен только на чтение (assistant) пропускает чтение, каталоги и сухие прогоны; всё, что двигает станок — пуск, отправка, базирование, джог, ручной кадр, — остаётся за человеком в интерфейсе, и это не снимается правами.

agent-script — 1
методпутьназначение
GET/api/agent/scriptGet Agent Script
ai — 7
методпутьназначение
POST/api/ai/chatChat
POST/api/ai/edit-codeEdit Code
GET/api/ai/providerGet Ai Provider
GET/api/ai/providersAi Providers
POST/api/ai/providers/{provider_id}/modelsAi Provider Models
POST/api/projects/{project_id}/ai/apply-planApply Plan
POST/api/projects/{project_id}/ai/recommend-planRecommend Plan
auth — 5
методпутьназначение
POST/api/auth/assistant-tokenВыпустить scoped read-only токен для LLM-ассистента
GET/api/auth/demoОткрыт ли демо-вход (для кнопки на форме входа)
POST/api/auth/demo-tokenВыдать гостю read-only токен без пароля
POST/api/auth/loginLogin
GET/api/meMe
automation — 65
методпутьназначение
GET/api/automation/archetypesКаталог архетипов блоков (§4 — как каталог конструкторов станков)
GET/api/automation/axes/stateAxes State
GET/api/automation/catalogМашинно-читаемый каталог операций автоматики
POST/api/automation/controlControl
POST/api/automation/datum/captureDatum Capture
POST/api/automation/gotoGoto
GET/api/automation/io/discoverIo Discover
POST/api/automation/jogJog
GET/api/automation/linesList Lines
POST/api/automation/linesCreate Line
GET/api/automation/lines/{line_id}Get Line
PUT/api/automation/lines/{line_id}Update Line
DELETE/api/automation/lines/{line_id}Delete Line
GET/api/automation/lines/{line_id}/run-statusЖивой ход последнего пуска линии (А1/А2)
POST/api/automation/lines/{line_id}/startПуск линии (А1) — последовательный запуск участников
GET/api/automation/lines/{line_id}/wiringПровода между блоками линии (PC8) — обе стороны сигнала и разрывы
GET/api/automation/mechanism-galleryОбразцы механизмов — что можно взять готовым
GET/api/automation/mechanism-gallery/{name}Каталог узла: механизм, паспорт и программа одним ответом
GET/api/automation/mechanism-gallery/{name}/{rel}Файл образца: механизм или его меш
GET/api/automation/powerPower State
POST/api/automation/powerPower Set
POST/api/automation/preflightПроверка сопоставления двигателей перед прогоном
GET/api/automation/programsПрограммы автоматики — все или ТОЛЬКО этого блока
POST/api/automation/programsCreate Program
POST/api/automation/programs/from-codeПрограмма автоматики из кода песочницы /lab/plc
GET/api/automation/programs/{program_id}Get Program
PUT/api/automation/programs/{program_id}Update Program
DELETE/api/automation/programs/{program_id}Delete Program
POST/api/automation/programs/{program_id}/duplicateКопия программы — рабочая, уже без признака демо
POST/api/automation/programs/{program_id}/startПуск сохранённой программы одной кнопкой (в т.ч. по кругу)
POST/api/automation/read-logRead Log
GET/api/automation/rigsList Rigs
POST/api/automation/rigsCreate Rig
GET/api/automation/rigs/defaultDefault Rig
POST/api/automation/rigs/from-archetypeСоздать блок из архетипа (предзаполненный rig)
POST/api/automation/rigs/from-machineАвтоматика ИЗ СТАНКА — копия его кинематики и IO (PLC поверх станка)
GET/api/automation/rigs/{rig_id}Get Rig
PUT/api/automation/rigs/{rig_id}Update Rig
DELETE/api/automation/rigs/{rig_id}Удалить блок — вместе с его витриной, но НЕ вместе с чужим замыслом
GET/api/automation/rigs/{rig_id}/analogВнешние аналоговые входы блока (PC7) — паспорт датчиков и дыры в нём
POST/api/automation/rigs/{rig_id}/mechanism/from-stepПрочитать STEP: дерево сборки, вердикт договора и ЧЕРНОВИК механизма
GET/api/automation/rigs/{rig_id}/mesh/{rel}Файл геометрии механизма блока
GET/api/automation/rigs/{rig_id}/meshesГеометрия механизма блока — что лежит и чего не хватает
POST/api/automation/rigs/{rig_id}/seedSeed Rig
GET/api/automation/rigs/{rig_id}/servo-passportПаспорта серво блока — профиль движения, источник числа и дыры
POST/api/automation/rigs/{rig_id}/taskЗадание блоку (task-API §3) — сейчас plan/dry-run
GET/api/automation/rigs/{rig_id}/urdfМеханизм блока (URDF) — звенья, шарниры, оси, пределы
POST/api/automation/rigs/{rig_id}/urdfПринести СВОЙ механизм блока (URDF) — импорт с судьёй у двери
DELETE/api/automation/rigs/{rig_id}/urdfСнять принесённый механизм — вернуться к нашему черновику
POST/api/automation/runRun
POST/api/automation/startStart
GET/api/automation/statusStatus
POST/api/automation/validateСухой прогон спеки автоматики (без исполнения)
GET/api/automation/{rig_id}/bindingBinding-паспорт rig'а для lab:plc (§3 конструктора узла)
GET/api/automation/{rig_id}/capabilitiesLLM-описание функций созданного блока (для BUSYA)
GET/api/automation/{rig_id}/config-hashОтпечаток набора железа rig'а (гейт быстрого канала, E3)
GET/api/automation/{rig_id}/config-statusКонфиг блока: актуален / устарел / нужен перезапуск? (A4+U18, зеркало станка)
POST/api/automation/{rig_id}/make-currentСделать автоматику текущей на стенде (G1 — полиморфный current)
POST/api/automation/{rig_id}/materializeМатериализация файлов автоматики из партитуры (E2)
POST/api/automation/{rig_id}/push-scoreБыстрая перезапись партитуры (score) с hash-гейтом (E3)
POST/api/automation/{rig_id}/resync-from-machineПересобрать копию из станка (кнопка «Синхронизировать со станком»)
GET/api/automation/{rig_id}/runsЖурнал прогонов блока (А8) — когда, какая программа, чем кончилось
POST/api/automation/{rig_id}/runs/outcomeОтметить, чем кончился прогон блока (А8)
GET/api/automation/{rig_id}/source-statusКопия со станка не разъехалась? (зеркало config-status)
POST/api/automation/{rig_id}/syncСинк — дозалить файлы автоматики на стенд (кнопка Синк, канон п.4)
axis-kinds — 2
методпутьназначение
GET/api/axis-kindsAll Kinds
GET/api/axis-kinds/{kind_id}One Kind
bus-arbiter — 5
методпутьназначение
GET/api/bus/bindingsBus Bindings View
POST/api/bus/claimBus Claim
POST/api/bus/releaseBus Release
GET/api/bus/slavesBus Slaves
GET/api/bus/statusBus Status
cad — 8
методпутьназначение
POST/api/cad/projects/from-codeSave Project From Code
POST/api/cad/projects/{project_id}/regenerate-from-manifestRegenerate From Manifest
GET/api/cad/templatesList Templates
POST/api/cad/templates/{template_id}/ai/buildAi Build Constructor Params
POST/api/cad/templates/{template_id}/instantiateInstantiate Constructor
POST/api/cad/templates/{template_id}/manifestBuild Constructor Manifest
GET/api/cad/templates/{template_id}/manifest/{params_hash}/{filename}Get Manifest State Stl
POST/api/cad/templates/{template_id}/previewPreview Constructor
cam-engines — 2
методпутьназначение
GET/api/cam-enginesList Engines
GET/api/cam-engines/{engine_id}/param-schemaGet Param Schema
chain — 1
методпутьназначение
GET/api/machines/{machine_id}/chainChain
compute-nodes — 12
методпутьназначение
GET/api/nodesList Nodes
POST/api/nodes/claimClaim Node
POST/api/nodes/claim-codesMint Claim Code
GET/api/nodes/{node_id}Get Node
DELETE/api/nodes/{node_id}Delete Node
POST/api/nodes/{node_id}/assignAssign Machine
POST/api/nodes/{node_id}/commissioning-configProvision Commissioning Config
GET/api/nodes/{node_id}/doctorDiagnose Stand
POST/api/nodes/{node_id}/quick-machineQuick Machine
GET/api/nodes/{node_id}/softwareGet Stand Software
POST/api/nodes/{node_id}/software/updateUpdate Stand Software
POST/api/nodes/{node_id}/tokenIssue Node Token
configs — 1
методпутьназначение
POST/api/configs/parseParse Configs
cutting-chain — 2
методпутьназначение
POST/api/cutting-chain/checkCheck Chain
GET/api/cutting-chain/formulasList Formulas
drive-faults — 2
методпутьназначение
GET/api/drive-faultsAll Tables
GET/api/drive-faults/{lcec_type}Table
effector-configs — 16
методпутьназначение
GET/api/effector-configsAll Configs
POST/api/effector-configsCreate Config
POST/api/effector-configs/from-preset/{preset_id}Create From Preset
GET/api/effector-configs/mesh-formatsMesh Formats
GET/api/effector-configs/presetsPresets
GET/api/effector-configs/{config_id}One Config
PATCH/api/effector-configs/{config_id}Update Config
DELETE/api/effector-configs/{config_id}Delete Config
POST/api/effector-configs/{config_id}/mechanismEffector Urdf Import
DELETE/api/effector-configs/{config_id}/mechanismEffector Urdf Drop
GET/api/effector-configs/{config_id}/mechanism.urdfМеханизм навесного (URDF) — принесённый или ЗАВОДСКОЙ
GET/api/effector-configs/{config_id}/mechanism/mesh/{rel}Effector Mechanism Mesh File
GET/api/effector-configs/{config_id}/mechanism/meshesEffector Mechanism Meshes
GET/api/effector-configs/{config_id}/meshGet Mesh
POST/api/effector-configs/{config_id}/meshUpload Mesh
DELETE/api/effector-configs/{config_id}/meshDelete Mesh
effector-kinds — 2
методпутьназначение
GET/api/effector-kindsAll Kinds
GET/api/effector-kinds/{kind_id}One Kind
generators — 3
методпутьназначение
GET/api/generatorsAll Generators
GET/api/generators/{generator_id}One Generator
POST/api/generators/{generator_id}/runRun Generator
health — 1
методпутьназначение
GET/api/healthHealth
jobs — 1
методпутьназначение
GET/api/jobs/{job_id}/gcodeGet Job Gcode
kinematics — 2
методпутьназначение
GET/api/kinematics/templatesAll Templates
GET/api/kinematics/templates/{template_id}One Template
machine-commands — 35
методпутьназначение
POST/api/machines/{machine_id}/bus-configBus Config
GET/api/machines/{machine_id}/config-statusConfig Status
GET/api/machines/{machine_id}/drive-ioDrive Io
PATCH/api/machines/{machine_id}/drive-ioDrive Io Set
POST/api/machines/{machine_id}/drive-io/read-from-drivesDrive Io Read From Drives
GET/api/machines/{machine_id}/effector-axesEffector Axes
GET/api/machines/{machine_id}/equipment-checkEquipment Check
POST/api/machines/{machine_id}/estopEstop
POST/api/machines/{machine_id}/estop-resetEstop Reset
POST/api/machines/{machine_id}/fault-resetFault Reset
PATCH/api/machines/{machine_id}/io-bindingIo Set Binding
GET/api/machines/{machine_id}/io-channelsIo Channels
PATCH/api/machines/{machine_id}/io-presentIo Set Present
GET/api/machines/{machine_id}/io-rolesIo Roles
GET/api/machines/{machine_id}/io-stationIo Station
PUT/api/machines/{machine_id}/io-stationSet Io Station
GET/api/machines/{machine_id}/last-runLast Run
POST/api/machines/{machine_id}/launchLaunch
POST/api/machines/{machine_id}/load-gcodeLoad Gcode
POST/api/machines/{machine_id}/make-currentMake Current
POST/api/machines/{machine_id}/mdiMdi
POST/api/machines/{machine_id}/pausePause
GET/api/machines/{machine_id}/pinmapPinmap
POST/api/machines/{machine_id}/probeProbe
POST/api/machines/{machine_id}/provisionProvision Machine
GET/api/machines/{machine_id}/reference-diffReference Diff
POST/api/machines/{machine_id}/rescan-busRescan Bus
POST/api/machines/{machine_id}/resumeResume
POST/api/machines/{machine_id}/snapshot-referenceSnapshot Reference
GET/api/machines/{machine_id}/spindle-driveSpindle Drive
PUT/api/machines/{machine_id}/spindle-driveSet Spindle Drive
POST/api/machines/{machine_id}/startStart
POST/api/machines/{machine_id}/stepStep
POST/api/machines/{machine_id}/stopStop
GET/api/machines/{machine_id}/transport-logTransport Log Tail
machine-constructors — 6
методпутьназначение
GET/api/machine-constructorsList Constructors
POST/api/machine-constructors/sync-axis-travel/{machine_id}Sync Axis Travel
POST/api/machine-constructors/{constructor_id}/buildBuild
POST/api/machine-constructors/{constructor_id}/download.zipDownload Zip
POST/api/machine-constructors/{constructor_id}/instantiateInstantiate
POST/api/machine-constructors/{constructor_id}/saveSave
machine-health — 3
методпутьназначение
POST/api/machines/{machine_id}/health-checkStart Health Check
GET/api/machines/{machine_id}/health-checkHealth Check Status
POST/api/machines/{machine_id}/health-check/stopStop Health Check
machine-mechanism — 6
методпутьназначение
POST/api/machines/{machine_id}/mechanismПринести СВОЙ механизм станка (URDF + меши) — судья у двери
DELETE/api/machines/{machine_id}/mechanismСнять свой механизм — станок снова отвечает заводской моделью
GET/api/machines/{machine_id}/mechanism.urdfМеханизм станка (URDF) — принесённый или ЗАВОДСКОЙ
GET/api/machines/{machine_id}/mechanism.zipЭкспорт механизма ПАКЕТОМ — та же структура, какой его и приносят
GET/api/machines/{machine_id}/mechanism/mesh/{rel}Файл геометрии механизма станка
GET/api/machines/{machine_id}/mechanism/meshesГеометрия механизма станка — что лежит и что об этом сказано
machine-runtime — 35
методпутьназначение
POST/api/machines/{machine_id}/bind_deviceBind Device Ep
POST/api/machines/{machine_id}/capture_zeroCapture Zero
POST/api/machines/{machine_id}/command/{cmd}Command
POST/api/machines/{machine_id}/coolantCoolant Control Ep
POST/api/machines/{machine_id}/effector-procedureEffector Procedure
POST/api/machines/{machine_id}/enc-zero-staleEnc Zero Stale
POST/api/machines/{machine_id}/feed_overrideFeed Override Ep
GET/api/machines/{machine_id}/gateGate State
POST/api/machines/{machine_id}/gotoGoto
POST/api/machines/{machine_id}/homeHome
POST/api/machines/{machine_id}/home_axisHome Axis
POST/api/machines/{machine_id}/jogJog
POST/api/machines/{machine_id}/jog_stopJog Stop
GET/api/machines/{machine_id}/positionGet Position
GET/api/machines/{machine_id}/program-on-standProgram On Stand
POST/api/machines/{machine_id}/read-logRead Log
POST/api/machines/{machine_id}/recover-travelRecover Travel
POST/api/machines/{machine_id}/reset-zeroReset Zero
POST/api/machines/{machine_id}/run-from-lineRun From Line
GET/api/machines/{machine_id}/run-from-line/{line}/previewRun From Line Preview
GET/api/machines/{machine_id}/runsRuns History
POST/api/machines/{machine_id}/runs/outcomeRuns Outcome
POST/api/machines/{machine_id}/safe-liftSafe Lift
POST/api/machines/{machine_id}/sdo_readSdo Read Ep
POST/api/machines/{machine_id}/sdo_writeSdo Write Ep
POST/api/machines/{machine_id}/send_jobSend Job
POST/api/machines/{machine_id}/servoServo
POST/api/machines/{machine_id}/set_zeroSet Zero
POST/api/machines/{machine_id}/spindleSpindle Control Ep
POST/api/machines/{machine_id}/spindle_overrideSpindle Override Ep
GET/api/machines/{machine_id}/stateGet State
POST/api/machines/{machine_id}/stock-probeStock Probe
GET/api/machines/{machine_id}/torque-stateTorque State
POST/api/machines/{machine_id}/touch-off-torqueTouch Off Torque
POST/api/machines/{machine_id}/travel-commissionTravel Commission
machines — 29
методпутьназначение
GET/api/machinesList All
POST/api/machinesCreate
POST/api/machines/importImport Machine
GET/api/machines/{machine_id}Get One
PATCH/api/machines/{machine_id}Patch
DELETE/api/machines/{machine_id}Remove
PATCH/api/machines/{machine_id}/axes/{axis}/motorPatch Axis Motor
GET/api/machines/{machine_id}/axis-passportAxis Passport
GET/api/machines/{machine_id}/cell-framesList Cell Frames
POST/api/machines/{machine_id}/cell-framesTeach Cell Frame
DELETE/api/machines/{machine_id}/cell-frames/{frame_id}Delete Cell Frame
POST/api/machines/{machine_id}/drive_fault_labelsDrive Fault Labels
GET/api/machines/{machine_id}/effectorGet Effector
POST/api/machines/{machine_id}/equip-from-programEquip From Program
GET/api/machines/{machine_id}/exportExport Machine
GET/api/machines/{machine_id}/install-scriptInstall Script
GET/api/machines/{machine_id}/program-equipment-checkProgram Equipment Check
GET/api/machines/{machine_id}/program-fitnessProgram Fitness
GET/api/machines/{machine_id}/setupGet Setup
PATCH/api/machines/{machine_id}/setupPatch Setup
POST/api/machines/{machine_id}/shutdownShutdown
GET/api/machines/{machine_id}/spindle-passportSpindle Passport
PATCH/api/machines/{machine_id}/spindle-passportPatch Spindle Passport
GET/api/machines/{machine_id}/tokenShow Token
POST/api/machines/{machine_id}/tools/from-catalogInstall Tool From Catalog
DELETE/api/machines/{machine_id}/tools/{slot}Remove Tool Slot
GET/api/machines/{machine_id}/tools/{slot}/cutting-dataSlot Cutting Data View
GET/api/machines/{machine_id}/tools/{slot}/usageTool Slot Usage View
GET/api/machines/{machine_id}/zero_proposalZero Proposal
materials — 4
методпутьназначение
GET/api/materialsAll Materials
POST/api/materials/recommend-feedsRecommend Feeds
GET/api/materials/{material_id}One Material
POST/api/materials/{material_id}/calculate_feedsFeeds For Material
omron-io — 3
методпутьназначение
GET/api/omron/healthOmron Health
POST/api/omron/setOmron Set
GET/api/omron/stateOmron State
operations — 13
методпутьназначение
GET/api/projects/{project_id}/gcode-merged.ncDownload Merged
GET/api/projects/{project_id}/operationsList Ops
POST/api/projects/{project_id}/operationsCreate Op
POST/api/projects/{project_id}/operations/drilling-batchCreate Drilling Batch
POST/api/projects/{project_id}/operations/reorderReorder Ops
GET/api/projects/{project_id}/operations/{op_id}Get Op
PATCH/api/projects/{project_id}/operations/{op_id}Patch Op
DELETE/api/projects/{project_id}/operations/{op_id}Delete Op
GET/api/projects/{project_id}/operations/{op_id}/gcode.ncDownload Op Gcode
POST/api/projects/{project_id}/operations/{op_id}/generateGenerate Op
GET/api/projects/{project_id}/operations/{op_id}/state.stlDownload Op State
GET/api/projects/{project_id}/operations/{op_id}/tool-checkTool Check
POST/api/projects/{project_id}/operations/{op_id}/validate-gcodeValidate Op Gcode
pin-catalog — 2
методпутьназначение
POST/api/machines/{machine_id}/monitor/readMonitor Read
GET/api/machines/{machine_id}/pin-catalogPin Catalog
plc — 8
методпутьназначение
POST/api/plc/checkCheck
POST/api/plc/compileCompile Program
POST/api/plc/deployDeploy
POST/api/plc/startStart
GET/api/plc/statusStatus
POST/api/plc/stopStop
POST/api/plc/traceTrace
POST/api/plc/unloadUnload
preflight — 2
методпутьназначение
POST/api/projects/{project_id}/operations/{op_id}/preflightPreflight Operation
POST/api/projects/{project_id}/preflightPreflight Project
probing — 1
методпутьназначение
POST/api/probing/z0Z0 Probe
profiles — 5
методпутьназначение
GET/api/profilesList All
POST/api/profilesCreate
GET/api/profiles/{profile_id}Get One
PUT/api/profiles/{profile_id}Update
DELETE/api/profiles/{profile_id}Remove
projects — 9
методпутьназначение
GET/api/projectsAll Projects
POST/api/projectsCreate
GET/api/projects/{project_id}One Project
PATCH/api/projects/{project_id}Patch
DELETE/api/projects/{project_id}Remove
GET/api/projects/{project_id}/gcode.ncDownload Gcode
POST/api/projects/{project_id}/stock/from-stepStock From Step
GET/api/projects/{project_id}/tool_tblDownload Tool Tbl
GET/api/projects/{project_id}/validationProject Validation
robot-motion — 2
методпутьназначение
POST/api/robot-motion/joint-gcodeJoint Gcode
POST/api/robot-motion/weld-passWeld Pass
run-chains — 16
методпутьназначение
GET/api/run-chainsList Chains
POST/api/run-chainsCreate Chain
POST/api/run-chains/from-programsCreate Chain From Programs
GET/api/run-chains/{chain_id}One Chain
PUT/api/run-chains/{chain_id}Update Chain
DELETE/api/run-chains/{chain_id}Delete Chain
GET/api/run-chains/{chain_id}/amlExport Chain As Aml
GET/api/run-chains/{chain_id}/box-stateChain Box State
POST/api/run-chains/{chain_id}/box/revokeBox Revoke Chain
POST/api/run-chains/{chain_id}/box/runBox Run Chain
POST/api/run-chains/{chain_id}/box/stopBox Stop Chain
POST/api/run-chains/{chain_id}/bundleBundle Chain
POST/api/run-chains/{chain_id}/deploy-to-boxDeploy Chain To Box
POST/api/run-chains/{chain_id}/planPlan Chain
GET/api/run-chains/{chain_id}/runsList Chain Runs
POST/api/run-chains/{chain_id}/suggestSuggest Chain
run-outcomes — 1
методпутьназначение
GET/api/run-outcomesАзбука исходов кольца прогонов по неймспейсам
scan — 1
методпутьназначение
POST/api/scan/previewScan Preview
stand-events — 2
методпутьназначение
GET/api/machines/{machine_id}/eventsGet Events
POST/api/machines/{machine_id}/eventsPost Events
tools — 16
методпутьназначение
GET/api/toolsAll Tools
POST/api/toolsCreate
GET/api/tools/catalogsTool Catalogs
GET/api/tools/export/linuxcnc.tblExport Linuxcnc Tbl
POST/api/tools/from_cadenas_urlImport From Cadenas Url
POST/api/tools/fusion/importImport From Fusion
POST/api/tools/parse_cadenas_urlParse Cadenas Url
POST/api/tools/suitabilityTools Suitability
GET/api/tools/{tool_id}One Tool
PATCH/api/tools/{tool_id}Patch
DELETE/api/tools/{tool_id}Remove
GET/api/tools/{tool_id}/mesh.objGet Mesh
POST/api/tools/{tool_id}/mesh.obj/rebuildRebuild Mesh
GET/api/tools/{tool_id}/thumbnailGet Thumbnail
POST/api/tools/{tool_id}/thumbnailUpload Thumbnail
DELETE/api/tools/{tool_id}/thumbnailDelete Thumbnail
transfer — 2
методпутьназначение
POST/api/transfer/gcode.ncDownload Transfer
POST/api/transfer/previewPreview Transfer
ui-events — 3
методпутьназначение
POST/api/ui-eventsPost Ui Events
GET/api/ui-eventsGet Ui Events
GET/api/ui-events/levelsGet Levels
Порождено из кода. Источник: backend/src/aicnc/main.py :: app.openapi()
Пересборка: bash /opt/synctwin/site/scripts/refresh-integrator.sh · снято 2026-09-11T20:07:30+00:00
Руками на этой странице написано: два вводных абзаца