Skip to main content

API 데이터

워크플로우 API 배포 노드에서 받을 입력 데이터 구조를 미리 정의하는 노드입니다.

설명​

API 데이터 노드는 워크플로우 API 배포 노드에서 받을 입력 데이터의 구조를 미리 정의하는 노드입니다. 워크플로우를 설계할 때 "어떤 데이터가 들어올 것인가"를 미리 정의하여, 그 데이터를 어떻게 사용할지 워크플로우를 구성할 수 있습니다.

예를 들어, {"text": ["안녕하세요?"]}와 같은 JSON 구조를 정의하면, 워크플로우 API 배포 노드로 배포된 워크플로우는 외부에서 이 구조의 데이터를 받아 처리할 수 있습니다.

포트 구성​

입력 포트​

없음

출력 포트​

  • 데이터셋: 정의한 데이터 구조가 포함된 데이터셋

속성​

데이터 구조 정의​

워크플로우 API 배포 노드에서 받을 입력 데이터의 구조를 JSON 형식으로 정의합니다.

예시:

{
  "text": ["안녕하세요?"]
}

또는

{
  "name": "홍길동",
  "age": 30,
  "email": "hong@example.com"
}

사용 방법​

  1. API 데이터 노드를 캔버스에 추가합니다
  2. 속성에서 받을 데이터 구조를 JSON 형식으로 정의합니다
  3. 이 노드의 출력 포트를 워크플로우의 시작점에 연결합니다
  4. 워크플로우를 구성하여 정의한 데이터 구조를 사용합니다
  5. 워크플로우 API 배포 노드로 워크플로우를 배포합니다

워크플로우 예시​

1. API 데이터 노드에서 입력 구조 정의​

{
  "text": ["안녕하세요?"]
}

2. 워크플로우 구성​

API 데이터 노드 → (다른 노드들) → 워크플로우 API 배포 노드

3. API 배포 후 외부에서 호출​

curl -X POST "https://api.ai-canvas.io/api-deploy/..." \
  -H "Content-Type: application/json" \
  -d '{
   "text": ["안녕하세요?"]
}'

API 데이터 노드에서 정의한 구조와 동일한 형식으로 데이터를 전송하면, 워크플로우가 정상적으로 실행됩니다.

주의사항​

데이터 구조 일치

워크플로우 API 배포 노드로 배포된 워크플로우를 호출할 때는, API 데이터 노드에서 정의한 구조와 정확히 일치하는 형식으로 데이터를 전송해야 합니다.

워크플로우 설계

API 데이터 노드를 먼저 정의하면, 어떤 데이터가 들어올지 미리 알 수 있어 워크플로우를 더 효율적으로 설계할 수 있습니다.

예제​

API 데이터 예제