AI 프롬프트 목록 조회

검색 조건과 일치하는 AI 프롬프트 목록을 조회합니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/ai/prompts?offset=0&limit=20"

요청 매개변수

정상 응답

{
  "total_count": 1,
  "prompts": [
    {
      "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "app_code": null,
      "app_built_in": null,
      "name": "qna-default",
      "description": "기본 질의응답 프롬프트",
      "enabled": true,
      "type": "qna",
      "prompt": "prompt: |\n  You are a helpful assistant.\n",
      "token_count": 128,
      "rev": 1,
      "created": "2024-09-15 14:30:00+0900",
      "updated": "2024-09-15 14:30:00+0900"
    }
  ]
}

• total_count (32비트 정수): 검색 조건과 일치하는 전체 프롬프트 수
• prompts (배열): 프롬프트 목록
  • guid (문자열): 프롬프트 GUID (36자)
  • app_code (문자열): 프롬프트를 등록한 앱의 코드 (앱이 등록한 프롬프트가 아닌 경우 null)
  • app_built_in (불리언): 앱 내장 프롬프트 여부 (앱이 등록한 프롬프트가 아닌 경우 null)
  • name (문자열): 프롬프트 이름
  • description (문자열): 프롬프트 설명
  • enabled (불리언): 활성화 여부 (true: 활성화, false: 비활성화)
  • type (문자열): 프롬프트 유형 (plan, action, qna)
  • prompt (문자열): YAML 형식의 프롬프트 정의
  • token_count (32비트 정수): 프롬프트의 토큰 개수
  • rev (32비트 정수): 프롬프트 리비전 번호
  • created (문자열): 프롬프트 생성 시각 (yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 프롬프트 수정 시각 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "offset should be not null"
}

offset, limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}