이 API는 대화형 답변 생성 API 응답에 포함된 입력폼 데이터를 제출할 때 사용합니다.
입력폼 제출 시 사용자 입력값을 저장하고, 이후 후속 에이전트 작업이 있으면 자동으로 이어서 실행합니다.
따라서 이 API의 응답으로 일반 텍스트 답변, 추가 입력폼, 카드형 응답, 페이지 이동 데이터 등이 반환될 수 있습니다.
<aside> 💡
https://api.sidetalk.ai/v1/chat/input-forms/submit
</aside>
POST
| 헤더 | 값 | 설명 |
|---|---|---|
| Content-Type | application/json | 요청 본문이 JSON 형식임을 나타냅니다. |
| Authorization | Bearer <api_key> | Sidetalk 대시보드에서 설치하기 메뉴에 제공된 API 키를 사용하세요. |
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| sessionId | String | 예 | 대화 세션을 구분하는 고유 키(Key)입니다. 입력폼 제출 내역을 같은 사용자 흐름과 연결하려면 동일한 값을 유지해야 합니다. |
| chat_log_uuid | String | 아니요 | 해당 입력폼이 연결된 대화 로그 UUID입니다. |
| message | String | 아니요 | 입력폼 제출 후 후속 답변 생성에 사용할 메시지입니다. 지정하지 않으면 기본 메시지로 처리될 수 있습니다. |
| stream | Boolean | 아니요 | 응답을 스트림으로 받을지 여부를 지정합니다. true 또는 false. 지정하지 않으면 기본값 false가 사용됩니다. |
| inputForm | Object | 예 | 입력폼 제출 데이터 객체입니다. |
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| form_id | String 또는 Number | 예 | 제출할 입력폼 ID입니다. |
| task_id | String | 아니요 | 해당 입력폼이 연결된 작업 ID입니다. |
| order | Number | 아니요 | 작업 내 액션 순서입니다. |
| original_chat_log_uuid | String | 아니요 | 입력폼이 처음 표시된 대화 로그 UUID입니다. |
| executionHistory | Array | 아니요 | 이전 에이전트 실행 이력입니다. |
| form_data | Object | 예 | 사용자가 입력한 필드 값입니다. 각 key는 입력폼 정의의 field_id 와 동일해야 합니다. |