개발가이드AI•LLMLLM 챗봇 구축 가이드

LLM 챗봇 구축 가이드

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

역할과 말투가 정해진 챗봇을 만드는 방법입니다. 매 요청에 같은 system 지시문과 대화 기록을 보내고, 응답 속도·길이·비용을 조절합니다.

POSThttps://apick.app/rest/llm/chat
인증
Bearer 키
요청 형식
form-data
응답
JSON · SSE
경로
1개

알아둘 점

이 가이드가 다루는 것

요소
쓰는 값
역할·말투 고정
system
대화 이어 가기
messages[n][role]·messages[n][content], compact[strategy]
빠른 응답·짧은 답변
speed=fast, max_tokens
SSE로 받기
stream=true

여러 턴 대화의 기본은 멀티챗 가이드, 회사 정책·출력 형식·거절 규칙까지 지키게 하려면 에이전트 구축 가이드를 보세요.

system 작성 기준

지시문은 저장되지 않습니다. 대화의 모든 요청에 같은 system을 보내세요. messages에 이미 system 메시지가 있으면 그것을 쓰므로, 이전 응답의 compacted_messages를 그대로 보낼 때는 system을 생략해도 됩니다.

요소
예시
역할
당신은 친절한 한국어 요리 도우미입니다.
답변 형식
재료, 조리 순서, 예상 시간을 구분해 답하세요.
길이
전체 6문장 이내로 답하세요.
제약
확실하지 않은 내용은 추측하지 말고 확인이 필요하다고 안내하세요.

SSE로 받기 (선택)

stream=true면 text/event-stream으로 응답합니다. 첫 data 이벤트의 choices[0].delta.content에 답변 전체가 담기고, 이어서 event: done 이벤트에 cost·pl_id·compacted_messages가 옵니다. 실패하면 event: error의 msg로 사유를 알려 줍니다. 답변이 글자 단위로 나뉘어 오지는 않으므로, SSE 클라이언트를 이미 쓰는 환경이 아니라면 일반 JSON 응답을 권장합니다. 형식은 대화 API 레퍼런스를 참고하세요.

운영 체크리스트

항목
권장
인증키 보호
브라우저·앱에서 직접 호출하지 말고 내 서버를 거쳐 호출합니다. 인증키는 서버 환경변수에만 둡니다.
실패 안내
400(입력 오류)·402(잔액 부족)는 다시 보내지 말고 안내 문구를 보여 줍니다. 502는 data.retryable이 true일 때 1~2초 뒤 한 번만 다시 보냅니다.
비용 관리
요청마다 api.cost를 사용자별로 합산해 하루 한도를 넘으면 안내합니다. api.pl_id로 포인트 사용 내역과 대조할 수 있습니다.
답변 길이
max_tokens와 system의 문장 수 제한을 함께 씁니다.
긴 대화
compact[strategy]=sliding_window, compact[window_pairs]=10.
대화 초기화
앱이 보관한 기록을 비우면 새 대화가 됩니다.

요청과 응답

API 요청
POST/rest/llm/chat
  • Bearer 인증
  • multipart/form-data
  • JSON · SSE 응답
요청 파라미터 26개 · 필수 1
파라미터
설명
modelstring필수
모델 id (llm_models Tool로 조회 가능, 예: openai/gpt-oss-120b)
예시
모델_목록에서_선택한_ID
systemstring선택
system 프롬프트 (역할·페르소나·정책·배경지식). 미지정 시 기본 한국어 어시스턴트 프롬프트가 적용됩니다
예시
당신은 친절한 한국어 요리 도우미입니다. 재료와 조리 순서를 구분해 6문장 이내로 답하세요.
messages[0][role]string조건부
각 메시지의 작성자. messages를 사용하면 각 항목에 필요합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 3가지입니다. system = 대화의 규칙·역할을 지정하는 시스템 메시지입니다. 사용자 메시지보다 먼저 적용됩니다. user = 사용자가 보낸 질문·지시 메시지입니다. assistant = 모델이 이전에 답한 메시지입니다. 대화 맥락을 이어 갈 때 넣습니다.
허용값
system user assistant
예시
user
messages[0][content]string조건부
각 메시지의 본문. 0부터 연속된 인덱스로 대화 순서를 전달합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
예시
집에 계란, 밥, 김치만 있어. 저녁 메뉴 추천해 줘.
messages[1][role]string조건부
두 번째 메시지 역할. 대화가 길어지면 번호를 1씩 늘립니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
messages[1][content]string조건부
두 번째 메시지 내용. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
messages[2][role]string조건부
세 번째 메시지 역할. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
messages[2][content]string조건부
세 번째 메시지 내용. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
compact[strategy]string선택
대화 유지 방식. none은 전체 유지, sliding_window는 최근 대화쌍을 유지, relevance는 최근 대화쌍과 마지막 질문에 필요한 이전 대화쌍만 모델에 보냅니다. 가능한 값은 3가지입니다. none = 해당 옵션을 적용하지 않는 값입니다. 생략했을 때의 기본 동작과 같습니다. sliding_window = 최근 대화쌍만 유지하는 압축 방식입니다. 오래된 대화는 모델에 전달되지 않습니다. relevance = 검색어와의 관련도가 높은 순서로 정렬하는 값입니다. 기본 정렬로 가장 많이 쓰입니다.
허용값
none sliding_window relevance
기본값
none
compact[window_pairs]integer선택
sliding_window·relevance에서 모델에 보낼 대화쌍 수. 최소 1, 기본 10입니다.
기본값
10
최솟값
1
max_tokensinteger선택
응답 최대 토큰. 미지정 시 모델 컨텍스트 기반 안전 상한으로 자동 설정, 명시한 값은 클램프 없이 그대로 적용
예시
512
speedstring선택
응답 속도/추론 깊이 — 'fast'(얕게, 빠름) | 'medium' | 'slow'(깊게, 느림). 한글 '빠름'|'중간'|'느림' 허용. 추론 특화 모델에서 효과가 큽니다
예시
fast
streamboolean선택
true이면 SSE 응답을 받습니다. false이면 완성된 JSON 응답을 받습니다. 생성된 내용을 정리한 뒤 전송하며 토큰별 전송을 보장하지 않습니다.
기본값
false
messagesarray선택
OpenAI 형식 [{role, content}] 배열. role 은 'system'|'user'|'assistant'. content 와 둘 중 하나는 필수, 동시 지정 시 messages 우선. 멀티턴 대화는 응답의 compacted_messages 를 다음 턴에 그대로 전송
contentstring선택
단발 입력 — 사용자 메시지 한 건만 보내는 간편 형태. messages 와 둘 중 하나는 필수
compactobject선택
히스토리 압축 옵션 { strategy: 'none'(기본) | 'sliding_window' | 'relevance', window_pairs: 유지할 user/assistant 페어 수 (기본 10, 최소 1) }. relevance 는 최근 대화와 함께 최신 질문에 필요한 이전 대화를 골라 남긴다. 긴 대화의 input 토큰 누적 방지
temperaturenumber선택
출력 다양성 0.0~2.0. 낮을수록 재현성, 높을수록 창의성 (미지정 시 모델 기본값)
messages[0][name]string선택
메시지 작성자의 이름. 사용하는 모델의 지원 여부를 확인하세요. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
messages[0][content][0][type]string조건부
여러 종류의 콘텐츠를 담을 때 항목의 종류. 같은 메시지의 content 문자열과 함께 보낼 수 없습니다. 가능한 값은 3가지입니다. text = 텍스트 프롬프트만으로 결과를 만드는 값입니다. 이미지 입력 없이 문장 묘사만 사용합니다. image_url = 이미지 주소를 담은 콘텐츠 조각입니다. 텍스트와 함께 보낼 수 있습니다. input_audio = 음성 입력을 담은 콘텐츠 조각입니다. 지원 모델에서만 사용할 수 있습니다.
허용값
text image_url input_audio
messages[0][content][0][text]string조건부
콘텐츠 항목이 text일 때 실제 텍스트입니다. 빈 문자열은 허용되지 않으며, 같은 메시지의 다른 콘텐츠와 순서대로 결합됩니다.
messages[0][content][0][image_url][url]string조건부
type=image_url일 때 이미지 URL 또는 data URL. 모델이 이미지 입력을 지원해야 합니다.
messages[0][content][0][image_url][detail]string선택
이미지 입력을 분석할 때 사용할 해상도 힌트입니다. auto는 모델 기본값, low는 빠르고 저렴, high는 작은 글자·세부 묘사에 유리합니다. 모델이 지원하지 않으면 무시됩니다. 가능한 값은 3가지입니다. auto = 서버·모델이 상황에 맞춰 자동으로 정하는 값입니다. 별도 지정이 필요 없습니다. low = 낮은 해상도·짧은 문맥처럼 비용과 속도를 우선하는 값입니다. high = 높은 해상도·긴 문맥처럼 정확도를 우선하는 값입니다. 토큰·처리 시간이 늘어납니다.
허용값
auto low high
messages[0][content][0][input_audio][data]string조건부
type=input_audio일 때 음성 Base64 값. 음성 입력 지원 모델에서만 사용합니다.
messages[0][content][0][input_audio][format]string조건부
음성 입력 형식. 모델에서 지원하는 형식을 사용합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
message[role]string선택
단일 메시지 객체의 역할. content 대신 객체로 보낼 때 사용합니다. 가능한 값은 3가지입니다. system = 대화의 규칙·역할을 지정하는 시스템 메시지입니다. 사용자 메시지보다 먼저 적용됩니다. user = 사용자가 보낸 질문·지시 메시지입니다. assistant = 모델이 이전에 답한 메시지입니다. 대화 맥락을 이어 갈 때 넣습니다.
허용값
system user assistant
message[content]string선택
단일 메시지 방식에서 사용하는 본문입니다. 문자열 또는 콘텐츠 배열을 받으며, messages 배열과 동시에 보내지 마세요.
응답 필드 21개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.modelstring
응답을 생성한 모델 ID입니다. 요청에서 지정한 모델과 같으며, 모델 목록 API의 id 값과 비교해 확인합니다.
data.messageobject
모델이 생성한 응답 메시지 묶음입니다. 작성자 역할과 답변 본문이 들어 있습니다.
data.usageobject
이번 응답의 토큰 사용량 묶음입니다. 입력·출력·합계 토큰 수가 들어 있으며 과금 계산의 기준이 됩니다.
data.compacted_messagesarray
문맥 압축으로 요약된 이전 메시지 목록입니다. 대화가 길어져 오래된 메시지를 압축했을 때 포함됩니다.
data.ic_idstring
이번 조회에 부여된 식별자입니다. 같은 요청의 결과를 추적하거나 문의할 때 사용하며, 값이 없으면 null입니다. null 허용.
data.resultinteger
조회 결과 본문입니다. 서비스가 찾은 실제 데이터가 들어 있으며, 자료가 없거나 조회에 실패하면 null이거나 필드가 생략됩니다.
data.msgstring
처리 결과를 사람이 읽을 수 있는 문장으로 설명합니다. 성공·실패 사유가 담기며, 오류 코드는 별도 필드에서 확인합니다.
data.successinteger
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_idinteger
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
하위 필드 7개 더 보기
응답 필드
설명
data.message.rolestring
메시지 작성자 역할입니다. 응답에서는 assistant입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.message.contentstring
모델이 생성한 답변 텍스트입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.usage.prompt_tokensinteger
입력(프롬프트)에 사용한 토큰 수입니다. 과금 계산의 입력 단가에 적용됩니다.
data.usage.completion_tokensinteger
출력(응답)에 사용한 토큰 수입니다. 과금 계산의 출력 단가에 적용됩니다.
data.usage.total_tokensinteger
입력과 출력 토큰을 합한 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.compacted_messages[].rolestring
압축된 이전 메시지의 작성자 역할입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.compacted_messages[].contentstring
문맥 압축으로 요약된 이전 메시지 내용입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
입력 조건·전송 규칙

temperature 등 나머지 항목은 대화 API 레퍼런스와 같습니다.

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 역할을 정한 첫 질문

요리 도우미 역할로 첫 질문을 보냅니다. 빠른 응답과 길이 상한을 함께 정합니다.

요청POST/rest/llm/chat
curl --fail-with-body --request POST 'https://apick.app/rest/llm/chat' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'system=당신은 친절한 한국어 요리 도우미입니다. 재료와 조리 순서를 구분해 6문장 이내로 답하세요.' \
  --form-string 'messages[0][role]=user' \
  --form-string 'messages[0][content]=집에 계란, 밥, 김치만 있어. 저녁 메뉴 추천해 줘.' \
  --form-string 'speed=fast' \
  --form-string 'max_tokens=512' \
  --form-string 'model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo'
  • 답변은 data.message.content, 다음 턴 기록은 data.compacted_messages입니다.
예시 2. 이어지는 대화를 최근 10쌍으로 유지

두 번째 질문부터는 이전 기록을 보내고 sliding_window로 길이를 관리합니다.

요청POST/rest/llm/chat
curl --fail-with-body --request POST 'https://apick.app/rest/llm/chat' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'system=당신은 친절한 한국어 요리 도우미입니다. 재료와 조리 순서를 구분해 6문장 이내로 답하세요.' \
  --form-string 'speed=fast' \
  --form-string 'max_tokens=512' \
  --form-string 'model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo' \
  --form-string 'messages[0][role]=user' \
  --form-string 'messages[0][content]=집에 계란, 밥, 김치만 있어. 저녁 메뉴 추천해 줘.' \
  --form-string 'messages[1][role]=assistant' \
  --form-string 'messages[1][content]=김치볶음밥을 추천해요. 재료와 순서를 알려 드릴까요?' \
  --form-string 'messages[2][role]=user' \
  --form-string 'messages[2][content]=응, 2인분 기준으로 알려 줘.' \
  --form-string 'compact[strategy]=sliding_window' \
  --form-string 'compact[window_pairs]=10'
  • system은 저장되지 않으므로 매 요청에 같은 값을 보냅니다.
  • api.cost를 사용자별로 합산해 하루 한도를 넘으면 안내합니다.
예시 3. SSE로 받기

챗봇 화면이 SSE 클라이언트로 응답을 받는 경우 stream=true를 보냅니다.

요청POST/rest/llm/chat
curl --fail-with-body --request POST 'https://apick.app/rest/llm/chat' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'system=당신은 친절한 한국어 요리 도우미입니다. 재료와 조리 순서를 구분해 6문장 이내로 답하세요.' \
  --form-string 'messages[0][role]=user' \
  --form-string 'messages[0][content]=집에 계란, 밥, 김치만 있어. 저녁 메뉴 추천해 줘.' \
  --form-string 'speed=fast' \
  --form-string 'max_tokens=512' \
  --form-string 'model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo' \
  --form-string 'stream=true' \
  --no-buffer
  • 첫 data 이벤트의 choices[0].delta.content를 화면에 표시합니다.
  • event: done의 compacted_messages를 다음 턴 기록으로 저장합니다. event: error면 msg를 안내합니다.
예시 4. 다른 역할의 챗봇

system만 바꾸면 고객센터·튜터·번역기 같은 다른 챗봇이 됩니다.

요청POST/rest/llm/chat
curl --fail-with-body --request POST 'https://apick.app/rest/llm/chat' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form-string 'messages[0][role]=user' \
  --form-string 'speed=fast' \
  --form-string 'max_tokens=512' \
  --form-string 'model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo' \
  --form-string 'system=당신은 중학생에게 수학을 가르치는 친절한 튜터입니다. 정답을 바로 말하지 말고 힌트부터 주세요.' \
  --form-string 'messages[0][content]=일차방정식 2x + 3 = 11 어떻게 풀어?' \
  --form-string 'temperature=0.4'
  • 힌트 위주로 답하는지 data.message.content로 확인하고, 아니면 system에 규칙을 더 구체적으로 적습니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

응답 형식 stream=true의 SSE는 생성문을 정리한 뒤 choices[].delta.content를 전송합니다. event: done에는 model, usage, cost, pl_id, compacted_messages가 포함되고 실패는 event: error로 전달됩니다. 토큰별 즉시 전송을 보장하지 않습니다.

{
  "data": {
    "model": "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo",
    "message": { "role": "assistant", "content": "김치볶음밥을 추천해요.\n재료: 밥 1공기, 김치 반 컵, 계란 1개\n순서: 김치를 볶다가 밥을 넣고 볶은 뒤 계란 프라이를 올리세요.\n예상 시간: 15분" },
    "usage": { "prompt_tokens": 71, "completion_tokens": 58, "total_tokens": 129 },
    "compacted_messages": [
      { "role": "system", "content": "당신은 친절한 한국어 요리 도우미입니다. 재료와 조리 순서를 구분해 6문장 이내로 답하세요." },
      { "role": "user", "content": "집에 계란, 밥, 김치만 있어. 저녁 메뉴 추천해 줘." },
      { "role": "assistant", "content": "김치볶음밥을 추천해요.\n재료: 밥 1공기, 김치 반 컵, 계란 1개\n순서: 김치를 볶다가 밥을 넣고 볶은 뒤 계란 프라이를 올리세요.\n예상 시간: 15분" }
    ],
    "ic_id": null, "result": 1, "msg": "", "success": 1
  },
  "api": { "success": true, "cost": 5, "ms": 910, "pl_id": 12345 }
}

다른 역할의 챗봇(튜터·번역기·고객센터)은 system만 바꾸면 됩니다. 회사 정책에 따라 답해야 하면 에이전트 구축 가이드를 이어서 보세요.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금모델별 가격표 참고 · 요청당 기본 5P(2026-11-06부터)

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.