Share
Sign In

Sejong Server API

Veluga API 명세서 (v1)

벨루가에서 제공하는 API 명세서입니다.

공통(Common)

Response Template

벨루가에서 응답하는 모든 Response 템플릿은 아래와 같은 구조를 나타냅니다.
(이벤트 스트림 제외)
필드
타입
필수 여부
설명
success
boolean
Y
응답 성공 여부
data
`object
null`
Y
message
string
Y
응답 관련 메시지
errorCode
`string
null`
Y

Error

벨루가 서비스 이용하면서 다음과 같은 에러가 발생할 수 있습니다.
에러 코드
에러 상태
내용
MISSING_PARAMETER
400
필수 파라미터가 없습니다.
INVALID_PARAMETER
400
파라미터가 잘못되었습니다.
COMMON_SYSTEM_ERROR
500
알 수 없는 오류가 발생했습니다.
COMMON_BAD_REQUEST
400
잘못된 요청 입니다.
COMMON_FAILED_RESPONSE
500
데이터 불러오기에 실패 했습니다.
COMMON_NO_PERMISSION
403
권한이 없습니다.
COMMON_NO_AUTHORIZATION
401
인증이 유효하지 않습니다.
USER_NOT_FOUND
404
유저를 찾을 수 없습니다.
CHANNEL_NOT_FOUND
404
채널을 찾을 수 없습니다.
FILE_NAME_REQUIRED
400
파일 이름을 찾을 수 없습니다.
FILE_EXTENSION_NOT_FOUND
400
파일 확장자를 찾을 수 없습니다.
SESSION_NOT_FOUND
404
세션을 찾을 수 없습니다.
NO_AVAILABLE_USAGE
402
사용량을 모두 소진하였습니다.

학습API

파일 학습 요청

파일 학습을 요청합니다. 업로드 시 AI 서버에 학습 요청을 하고, 학습 결과를 조회하여 AI를 통해 확인할 수 있습니다.
curl -X POST "https://sejong-api.veluga.app/api/v1/document/file" \ -H "X-VELUGA-API-KEY: [YOUR_API_KEY]" \ -H "Content-Type: multipart/form-data" \ -F "channelId=[YOUR_CHANNEL_ID]" \ -F "file=@[PATH_TO_YOUR_FILE]"

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

헤더에 대한 설명은 다음과 같습니다.
헤더
필수 여부
설명
X-VELUGA-API-KEY
Y
벨루가 계정으로 발급받은 API KEY
Content-Type
multipart/form-data

요청 바디

바디에 대한 설명은 다음과 같습니다.
필드
타입
필수 여부
설명
channelId
string
Y
벨루가에서 생성한 채널 ID
file
binary
Y
요청할 파일입니다.
docFilter
object
N
사용자 정의 필터 입니다. 문서 검색에 사용할 인덱스 key를 자유롭게 설정할 수 있습니다. (예: {“tag”: “korea”})
지원하는 확장자: pdf, txt, docx, md, csv, html, htm

응답

응답 형식을 설명합니다.

응답 헤더

헤더에 대한 설명은 다음과 같습니다.
헤더
필수 여부
설명
Content-Type
-
application/json

응답 데이터

응답 데이터에 대한 설명은 다음과 같습니다.
필드
타입
필수 여부
설명
data
string
Y
학습 요청한 문서 ID

파일 리스트 조회

학습 요청된 파일 리스트를 조회합니다.
curl -X GET "https://sejong-api.veluga.app/api/v1/document/file" \ -H "X-VELUGA-API-KEY: [YOUR_API_KEY]" \ -G \ -d "channelId=[YOUR_CHANNEL_ID]" \ -d "keyword=[OPTIONAL_KEYWORD]" \ -d "page=[PAGE_NUMBER]" \ -d "limit=[LIMIT_NUMBER]" \ -d "sortType=[SORT_TYPE]" \ -d "sort=[SORT_ORDER]"

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

헤더에 대한 설명은 다음과 같습니다.
헤더
필수 여부
설명
X-VELUGA-API-KEY
Y
벨루가 계정으로 발급받은 API KEY

요청 파라미터

파라미터에 대한 설명은 다음과 같습니다.
필드
타입
필수 여부
설명
channelId
string
Y