Skip to main content

워크플로우 API 배포

워크플로우를 API로 배포하여 외부에서 호출할 수 있게 만드는 노드입니다.

설명​

워크플로우 API 배포 노드는 워크플로우를 API로 배포하여 외부에서 HTTP 요청으로 호출할 수 있게 만드는 노드입니다. 배포된 워크플로우는 REST API 엔드포인트로 제공되며, POST 요청을 통해 데이터를 전송하고 결과를 받을 수 있습니다.

워크플로우를 배포하기 전에 API 데이터 노드에서 입력 데이터 구조를 미리 정의해야 합니다. API 데이터 노드에서 정의한 구조와 동일한 형식으로 데이터를 전송하면 워크플로우가 정상적으로 실행됩니다.

포트 구성​

입력 포트​

  • 데이터셋: 배포할 워크플로우의 최종 출력 데이터셋

출력 포트​

없음

배포 및 호출​

배포하기​

배포하기 버튼을 클릭하면 워크플로우가 API로 배포되고, 호출할 수 있는 URL이 생성됩니다.

API 호출 예시​

배포된 API는 다음과 같이 호출할 수 있습니다:

cURL​

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

JavaScript (fetch)​

fetch(
  "https://api.ai-canvas.io/api-deploy/NjkwMTk4ZTVmNmExMzEwNzdiNDNkNGFmL25vZGUtYXBpRGVwbG95LXlsdGJteHVsb2dqdngyZ2YydGxpcWk=",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: ["안녕하세요?"],
    }),
  }
)
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

JavaScript (async/await)​

async function callAPI() {
  try {
    const response = await fetch(
      "https://api.ai-canvas.io/api-deploy/NjkwMTk4ZTVmNmExMzEwNzdiNDNkNGFmL25vZGUtYXBpRGVwbG95LXlsdGJteHVsb2dqdngyZ2YydGxpcWk=",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
        },
        body: JSON.stringify({
          text: ["안녕하세요?"],
        }),
      }
    );

    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error("Error:", error);
  }
}

callAPI();

요청 Body 구조​

요청 body는 API 데이터 노드에서 정의한 구조와 일치해야 합니다.

예시:

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

워크플로우 구성 예시​

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

API 데이터 노드에서 받을 데이터 구조를 정의합니다:

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

2. 워크플로우 구성​

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

3. 배포 및 호출​

워크플로우 API 배포 노드에서 배포하기를 클릭하여 배포하고, 생성된 URL로 API를 호출합니다.

워크플로우 API 배포 예제

주의사항​

API 데이터 노드와의 관계

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

배포 중단

배포를 중단하면 더 이상 외부에서 API를 호출할 수 없습니다.