RAGO-X API 및 기존 서비스 연동 개요

예상 활용 흐름

내부 시스템이나 고객지원 채널에서 질문을 전달하고, RAGO-X의 문서 기반 답변과 근거를 기존 사용자 화면에 연결하는 형태로 활용할 수 있습니다.

• 내부 업무 도구에서 지식 검색
• 고객지원 질문 연결
• 제품 문서 기반 안내
• 사내 포털 또는 챗 인터페이스 연동

구현 전에 확인할 항목

안정적인 운영을 위해 API 계약과 운영 한도를 먼저 확인해야 합니다.

• 인증 및 키 보관 방식
• 요청·응답 스키마
• 호출량·크레딧·속도 제한
• 오류 코드와 재시도 정책
• 근거 데이터 반환 형식
• 버전 정책과 변경 공지

공개 범위에 대한 주의

현재 랜딩은 API 기능의 존재를 안내하지만 상세 API 레퍼런스는 제공하지 않습니다. 실제 개발을 위한 샘플 코드는 서비스의 개발자 API 메뉴에서 확인 할 수 있습니다.

1. 연동할 문서함과 API Key 준비

서비스의 개발자 → API Key 관리에서 필요한 문서함만 선택해 키를 발급합니다. 키 원문은 발급 직후 한 번만 표시되므로 연동 서버에 보관하세요. 실제 API 기본 주소와 최신 요청 형식은 개발자 → API 사용 안내에서 확인합니다. 이 랜딩 사이트 주소는 API 서버 주소가 아닙니다.

2. 질문 접수와 답변 완료를 구분

키에 허용된 문서함을 조회한 뒤 사용할 문서함에 질문을 제출합니다. 접수 응답의 task_id로 SSE 스트림을 연결해 결과를 받으며, 스트림에도 질문을 제출한 동일한 키를 사용합니다. 작업 접수만으로 답변이 완성된 것은 아닙니다. 화면에서는 처리 중·완료·실패 상태를 구분하고, 상세 가이드의 cURL 예제로 각 단계를 확인하세요.

3. 사용자별 권한과 대화 분리

API Key의 허용 문서함과 로그인한 개별 사용자의 열람 권한은 다릅니다. 연동 서버에서 사용자가 선택한 문서함을 이용할 수 있는지 확인하고, 사용자·문서함·대화의 관계를 관리하세요. 예제의 고정 session_id를 모든 사용자가 공유하지 말고 실제 대화마다 구분된 값을 사용합니다.

4. 서비스에 연결하기 전 검증

대표 질문으로 답변과 반환된 근거를 비교하고, 허용되지 않은 문서함 요청과 스트림 중단도 시험하세요. 네트워크 데이터 조각을 SSE 이벤트 하나로 가정하지 말고 이벤트 경계까지 누적해 처리합니다. 재시도 정책은 최신 API 안내에 맞춰 정하고, 연결이 끊겼다고 질문을 무조건 다시 제출하지 마세요.