워크플로

핵심 플랫폼

workflow_definitions_read워크플로

시설의 워크플로 자동화를 읽습니다: 워크플로 목록, 워크플로 하나의 전체 그래프, 그래프에 사용할 수 있는 노드 유형, 선별된 템플릿. 그래프를 만들거나 편집하기 전에 node_types를 읽어 모든 유형과 매개변수가 해당 시설에서 유효한지 확인하십시오.

작업:

list: 워크플로 목록. 각 워크플로의 라이브 여부, 게시된 버전, 실행 횟수, 마지막 실행 및 노드(id, name, type). 브랜드 및 조직 워크플로는 나열되지 않습니다.
get: 워크플로를 가져옵니다. 전체 초안 그래프(노드, 연결, 메모, 설정)와 meta: active, publishedVersionId 및 게시된 경우 현재 라이브 그래프인 publishedWorkflow. 이 시설의 워크플로만 해당합니다. 필요한 값: workflowId.
node_types: 노드 유형. type, label, category, outputs(분기) 및 입력할 매개변수인 inputSchema가 포함된 팔레트 항목. 노드에 필요한 모듈이 시설에 없으면 available이 false이며 이유가 함께 표시됩니다. MCP 도구는 mcp.. 노드로 표시됩니다.
templates: 템플릿. 일반적인 자동화의 시작점으로, risk와 riskNote(부주의하게 게시할 경우 발생할 수 있는 문제), 노드 유형, 필요한 모듈, 이 시설에서의 사용 가능 여부 및 미리 보기 그래프를 포함합니다. workflow_definitions_write instantiate_template으로 그래프로 변환하십시오.

매개변수

이름	유형	설명
`action`*	`"list" \| "get" \| "node_types" \| "templates"`	수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
`limit`	`integer`	페이지당 항목 수(기본값 25, 최대 100)(list, node_types, templates)
`cursor`	`string`	이전 페이지의 nextCursor(list, node_types, templates)
`facilityId`	`string`	시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
`workflowId`	`string`	workflow_definitions_read list에서 가져온 워크플로 ID(get)
`query`	`string`	유형, 레이블, 설명 또는 검색어에서 찾을 단어(node_types)
`category`	`string`	이 카테고리만: trigger, action, logic 또는 ai(node_types)
`types`	`array`	설명할 정확한 유형, 예: 편집 중인 워크플로에 있는 유형. 팔레트에 더 이상 표시되지 않는 폐기된 유형도 포함하며, query와 category는 무시합니다.(node_types)

workflow_definitions_write워크플로

시설의 워크플로 자동화를 생성, 편집, 게시, 중지 및 삭제합니다. 작성 절차: workflow_definitions_read로 node_types를 읽고, 그래프를 만든 다음(또는 instantiate_template에서 시작), 초안으로 생성하고, workflow_runs_write test(시뮬레이션)로 시험한 후 게시합니다. 초안을 편집해도 게시하기 전까지는 라이브 버전이 변경되지 않습니다.

작업:

create: 워크플로를 생성합니다. 노드가 하나 이상인 전체 그래프로 새 비활성 초안을 저장합니다. name의 기본값은 "Untitled workflow"입니다. 유효성 검사 문제는 노드 세부 정보와 함께 errors로 반환됩니다. 필요한 값: nodes.
update: 초안을 저장합니다. 전체 초안을 대체하므로 변경 사항만이 아니라 모든 노드와 연결을 보내십시오. 게시할 때까지 라이브 버전은 계속 실행됩니다. 유효성 검사 문제는 노드 세부 정보와 함께 errors로 반환됩니다. 필요한 값: workflowId, nodes.
patch_meta: 이름을 변경합니다. 이름이나 설명만 변경하며 그래프와 라이브 버전은 그대로 유지됩니다. 둘 다 이미 일치하면 changed는 false입니다. 필요한 값: workflowId.
duplicate: 복제합니다. 워크플로를 새 노드 ID가 부여된 " (copy)" 이름의 새 초안으로 복사하며, 게시되거나 활성화되지 않습니다. 원본은 변경되지 않습니다. 필요한 값: workflowId.
delete: 삭제합니다. 초안, 게시된 버전, 실행 기록 및 트리거 라우팅을 포함하여 워크플로를 영구적으로 삭제합니다. set_active false는 워크플로를 유지한 채 중지하고, discard_draft는 초안 편집만 초기화합니다. 필요한 값: workflowId. 확인을 요청합니다.
discard_draft: 초안 편집을 취소합니다. 초안을 마지막으로 게시된 버전으로 되돌리고 그 이후의 편집을 버립니다. 라이브 버전에는 영향을 주지 않으며, 게시된 버전이 있어야 합니다. 필요한 값: workflowId. 확인을 요청합니다.
publish: 게시합니다. 초안의 유효성을 검사하고 라이브 버전으로 저장한 다음 워크플로를 켜므로, 트리거가 실행되고 작업이 실제로 수행됩니다. 진행 중인 실행은 이전 버전으로 완료됩니다. 대기 중인 Delay 단계의 시간이 재조정되어야 하는 경우 결과에 code WAIT_RETARGET_CONFIRMATION_REQUIRED와 impacts가 포함되므로, confirmWaitRetargets와 해당 impacts를 지정하여 다시 호출하십시오. 필요한 값: workflowId. 확인을 요청합니다.
set_active: 켜거나 끕니다. active true는 게시된 워크플로를 다시 켭니다. active false는 워크플로를 중지합니다. 트리거 실행이 멈추고 대기 중인 Delay 단계는 취소되어 완료되지 않습니다. 아무것도 삭제되지 않습니다. 이미 해당 상태가 아니면 먼저 확인을 요청합니다. 필요한 값: workflowId, active. 확인을 요청할 수 있습니다.
instantiate_template: 템플릿에서 그래프를 만듭니다. 템플릿을 create에 사용할 수 있는 그래프 { name, description, nodes, connections }로 변환하며 새 노드 ID를 부여합니다. 템플릿은 수신자, 출입문 및 시간을 의도적으로 비워 두므로 먼저 채우십시오. 아무것도 저장하지 않습니다. 필요한 값: templateId.
generate: 그래프를 생성합니다. 시설의 AI를 사용하여 일반 언어 프롬프트로 그래프를 만들고, 유효한 노드 유형만 사용한 { name, description, nodes, connections }를 반환합니다. 기존 워크플로를 수정하려면 workflow를 전달하십시오. 수정된 전체 그래프가 반환됩니다. 아무것도 저장하지 않지만 시설의 AI 크레딧을 사용합니다. 필요한 값: prompt. 확인을 요청합니다.

매개변수

이름	유형	설명
`action`*	`"create" \| "update" \| "patch_meta" \| "duplicate" \| "delete" \| "discard_draft" \| "publish" \| "set_active" \| "instantiate_template" \| "generate"`	수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
`name`	`string`	워크플로 이름(create, update, patch_meta)
`description`	`string`	워크플로가 수행하는 작업(create, update, patch_meta)
`nodes`	`array`	모든 노드: { id, name, type, position, parameters }. 유형과 매개변수는 workflow_definitions_read node_types에서 가져옵니다.(create, update)
`connections`	`object`	소스 노드 이름을 키로 하는 연결. 노드가 하나이면 비어 있을 수 있습니다(create, update)
`notes`	`array`	캔버스 메모(create, update)
`settings`	`object`	워크플로 설정(create, update)
`facilityId`	`string`	시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
`workflowId`	`string`	workflow_definitions_read list에서 가져온 워크플로 ID(update, patch_meta, duplicate, delete, discard_draft, publish, set_active)
`confirmWaitRetargets`	`boolean`	이전 결과의 impacts에 나열된 대기 중인 Delay 단계의 시간을 재조정합니다(publish)
`confirmedWaitRetargets`	`array`	WAIT_RETARGET_CONFIRMATION_REQUIRED 결과의 impacts를 변경하지 않고 다시 보냅니다(publish)
`active`	`boolean`	true이면 켜고, false이면 중지합니다(set_active)
`templateId`	`string`	workflow_definitions_read templates에서 가져온 템플릿 ID(instantiate_template)
`prompt`	`string`	워크플로가 수행해야 할 작업(generate)
`workflow`	`object`	새로 시작하는 대신 수정할, workflow_definitions_read get에서 가져온 전체 워크플로(generate)
`confirm`	`boolean`	첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다

workflow_runs_read워크플로

워크플로의 실행 기록(최신순)과 실행 하나의 단계별 내용입니다. 자동화가 실행되었는지 확인하거나, workflow_runs_write로 시작한 실행을 추적하거나, 어떤 노드가 왜 실패했는지 찾을 때 사용합니다.

작업:

list: 실행 목록. 각 실행의 상태, 모드(live 또는 test), 부수 효과, 트리거, 시작한 사람, 시간, 단계 수, 대기 중인 노드 및 오류. 필요한 값: workflowId.
get: 실행을 가져옵니다. 실행 상태와 모든 단계를 순서대로 보여 주며, 각 노드의 입력, 출력, 메모 및 오류를 포함합니다. 실행은 비동기식입니다. Delay가 있는 실행은 후속 실행 시점이 될 때까지 대기합니다. 필요한 값: workflowId, executionId.

매개변수

이름	유형	설명
`action`*	`"list" \| "get"`	수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
`workflowId`	`string`	workflow_definitions_read list에서 가져온 워크플로 ID
`limit`	`integer`	페이지당 항목 수(기본값 25, 최대 100) (list)
`cursor`	`string`	이전 페이지의 nextCursor (list)
`facilityId`	`string`	시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
`executionId`	`string`	workflow_runs_read list에서 가져온 실행 ID(get)

workflow_runs_write워크플로

워크플로 실행을 시작, 테스트 실행, 취소 및 재실행합니다. 부수 효과를 시뮬레이션하여 초안을 실행하는 test를 우선 사용하십시오. run은 게시된 워크플로를 실제로 실행합니다. 실행은 비동기식이므로 workflow_runs_read get으로 추적하십시오.

작업:

run: 지금 실행합니다. 게시된 워크플로를 수동 트리거(custom.manualTrigger)에서 실제 부수 효과와 함께 실행합니다. 일정, 웹훅 및 이벤트 트리거는 자동으로 실행됩니다. 실행의 executionId와 첫 상태를 반환합니다. 필요한 값: workflowId. 확인을 요청합니다.
test: 초안을 테스트합니다. 저장된 초안을 게시하지 않고 실행하며 테스트 실행으로 기록됩니다. 부수 효과는 기본적으로 시뮬레이션되어 아무것도 전송되거나 전환되지 않으며, 각 노드는 수행했을 작업을 보고합니다. sideEffects live는 먼저 확인을 요청합니다. 필요한 값: workflowId. 확인을 요청할 수 있습니다.
cancel: 대기 중인 실행을 취소합니다. Delay에서 대기 중인 실행을 취소하며, 대기 중인 항목이 종료되고 그 이후 단계는 실행되지 않습니다. 완료된 실행과 단계 진행 중인 실행은 취소할 수 없습니다. 필요한 값: workflowId, executionId. 확인을 요청합니다.
retry: 실행을 재실행합니다. 완료된 실행을 기록된 트리거 입력으로 다시 실행하며, retryOf로 원래 실행과 연결됩니다. published(기본값)는 해당 실행이 사용한 버전을 실제로 다시 실행하고 먼저 확인을 요청합니다. draft-test는 현재 초안을 시뮬레이션으로 실행하며, 실패를 수정하는 중에 적합합니다. 필요한 값: workflowId, executionId. 확인을 요청할 수 있습니다.

매개변수

이름	유형	설명
`action`*	`"run" \| "test" \| "cancel" \| "retry"`	수행할 작업입니다. 각 작업은 도구 설명에 설명되어 있습니다.
`workflowId`	`string`	workflow_definitions_read list에서 가져온 워크플로 ID
`nodeId`	`string`	시작할 트리거 노드 ID. 수동 트리거를 사용하려면 생략하십시오(run, test)
`payload`	`object`	트리거 이후 노드에 대한 입력, 예: { "visitorName": "Ada" }(run, test)
`facilityId`	`string`	시설 ID입니다. 연결된 시설을 대상으로 하는 경우 생략할 수 있습니다.
`sideEffects`	`"simulate" \| "live"`	노드 작업이 실제로 수행되는지 여부(test)
`executionId`	`string`	workflow_runs_read list에서 가져온 실행 ID(cancel, retry)
`mode`	`"published" \| "draft-test"`	재실행 기준(retry)
`confirm`	`boolean`	첫 번째 호출에서 반환된 미리 보기를 사용자가 확인한 후에만 설정합니다