GET /workflows/:workflowId

엔드포인트

GET /v1/workflows/{workflowId}

요청

curl -X GET "https://client-omni-api.argosidentity.com/v1/workflows/{workflowId}" \
  -H "x-api-key: your-api-key-here"

조회 응답은 리소스 객체를 그대로 반환합니다. 별도의 래퍼 필드로 감싸지 않습니다.

응답

string

필수

워크플로우 고유 ID (wf_ 접두사)

string

필수

이 워크플로우가 속한 프로젝트 ID (proj_ 접두사)

string

필수

워크플로우 이름

string | null

워크플로우 설명

string

필수

워크플로우 상태 (예: active)

string

필수

워크플로우에 설정된 자연어 정책 텍스트 전문. 이 텍스트로부터 플레이북이 생성됩니다

object | null

정책 참고용으로 첨부된 문서 정보. 첨부하지 않았으면 null

string

필수

현재 정책으로부터 생성된 플레이북 ID (PB- 접두사)

string

필수

플레이북 본문 (frontmatter + 액션 워크플로우 정의)

string

필수

플레이북 버전

object[]

필수

플레이북이 정의한 전체 단계 목록

array

필수

워크플로우에 첨부된 참고 노트 목록

object[]

필수

이 워크플로우에서 선택 가능한 엔진 카탈로그

object

필수

분석 결과의 구조를 정의하는 JSON Schema

number

필수

이 워크플로우에 연결된 프로필 수

number

필수

이 워크플로우로 실행된 누적 분석 수

string

필수

분석에 사용되는 AI 모델 ID

string

필수

AI 모델 제공자 식별자

object

필수

AI 모델 상세 정보

string

필수

생성 시각 (ISO 8601)

string

필수

최종 수정 시각 (ISO 8601)

`workflowActions[]` — 단계 정의

플레이북이 정의한 전체 단계입니다. 분석 응답의 agentAuditLog.steps는 이 중 실제로 실행된 것만 담기므로, 실행률을 계산하려면 이 배열을 분모로 사용하세요.

필드	타입	설명
`step`	`number`	단계 순번
`workId`	`number`	작업 ID. 분석 응답의 `workId`와 대응됩니다
`actionName`	`string`	액션 함수명
`description`	`string`	액션 설명
`engines`	`array`	이 단계에 설정된 엔진 목록

`engines[]` — 엔진 카탈로그

필드	타입	설명
`id`	`string`	엔진 ID
`code`	`string`	엔진 코드 (예: `aml-business`)
`name`	`string`	엔진 표시 이름
`description`	`string`	엔진 설명
`executionOrder`	`number`	실행 순서
`isSelected`	`boolean`	이 워크플로우에서 선택되었는지 여부
`isRequired`	`boolean`	필수 엔진 여부
`pricePerCall`	`number`	호출당 과금 단가

`aiModel`

필드	타입	설명
`modelId`	`string`	모델 식별자
`displayName`	`string`	모델 표시 이름
`provider`	`string`	제공자
`hostingLabel`	`string`	호스팅 구분 표시
`description`	`string`	모델 설명
`isDefault`	`boolean`	기본 모델 여부
`maxOutputTokens`	`number`	최대 출력 토큰 수

응답 예시

아래는 구조 이해를 돕기 위한 가상 예시입니다. policyText, playbookContent, outputSchema는 실제로는 훨씬 길며 워크플로우마다 다릅니다.

{
  "id": "wf_5t9j1r4b7m2q",
  "projectId": "proj_6h4y8s2f0v9n",
  "name": "Corporate Onboarding KYB",
  "description": "법인 온보딩 시 제출 서류의 완비성과 정합성을 검증합니다.",
  "status": "active",
  "policyText": "Entity type: Corporate\n\n필수 제출 서류: 사업자등록증, 법인등기부등본, 대표자 신분증...",
  "policyDocuments": null,
  "playbookId": "PB-20260701-AB12CD",
  "playbookContent": "---\nname: playbook.md\ndescription: Corporate Onboarding KYB\n---\n...",
  "playbookVersion": "1.0.0",
  "workflowActions": [
    {
      "step": 1,
      "workId": 1,
      "actionName": "verify_document_presence",
      "description": "필수 제출 서류의 존재 여부를 확인합니다",
      "engines": ["Text Verifier"]
    },
    {
      "step": 2,
      "workId": 2,
      "actionName": "extract_corporate_info",
      "description": "제출 서류에서 법인 정보를 추출합니다",
      "engines": []
    }
  ],
  "referenceNotes": [],
  "engines": [
    {
      "id": "eng_1a2b3c4d5e6f",
      "code": "text-verifier",
      "name": "Text Verifier",
      "description": "텍스트 유사도 비교",
      "executionOrder": 1,
      "isSelected": true,
      "isRequired": false,
      "pricePerCall": 0
    }
  ],
  "outputSchema": {
    "type": "object",
    "properties": {
      "corporate_info": {
        "type": "object",
        "description": "제출 서류에서 추출한 법인 정보",
        "properties": {
          "company_name": { "type": "string", "description": "법인명" },
          "registration_number": { "type": "string", "description": "법인 등록번호" }
        }
      }
    }
  },
  "profilesCount": 12,
  "totalAnalyses": 34,
  "aiModelId": "example/model-id",
  "aiModelProvider": "argos",
  "aiModel": {
    "modelId": "example/model-id",
    "displayName": "Example Model",
    "provider": "argos",
    "hostingLabel": "Managed",
    "description": "문서 분석용 기본 모델",
    "isDefault": true,
    "maxOutputTokens": 8192
  },
  "createdAt": "2026-06-30T08:15:55.195Z",
  "updatedAt": "2026-07-02T04:10:58.004Z"
}