코드 없이 사용하려면 이 문서 대신 활용 가이드를 보세요. AI 도구에 자연어로 요청하는 방식이며, REST API는 직접 집계나 대시보드 연동 등 프로그래밍 방식이 필요할 때 사용합니다.
베이스 URL
인증
조직 API 키를API-Key 헤더로 전달합니다. 모든 요청은 키가 속한 조직으로 범위가 한정됩니다. 자세한 내용은 API 키를 참고하세요.
리소스 구조
리소스 간 관계는 핵심 개념을 참고하세요.
브랜드는 수집 파이프라인과 독립된 리소스입니다. 실행 요청에 브랜드가 필요하지 않으며, 답변에서 브랜드 언급을 찾는 분석은 브랜드의 이름·동의어를 답변 본문(
content)·출처(sources)와 대조하는 방식으로 수행합니다.공통 규칙
페이지네이션
목록 엔드포인트는 응답에nextCursor를 반환합니다. 이 값을 다음 요청의 cursor 쿼리 파라미터로 전달하면 다음 페이지를 가져오고, null이면 마지막 페이지입니다. 페이지 크기는 limit으로 지정합니다(기본 20, 최대 100 — 단, GET /runs는 최대 10). 자세한 규칙은 답변 수집하기를 참고하세요.
ID 형식
모든 리소스 ID는 22자 문자열입니다(예:GULjgaLy-DjX9NAVxjZBFg). 형식이 잘못된 ID는 404가 아니라 400으로 거부됩니다.
날짜 형식
날짜·시간은 RFC3339 문자열입니다(예:2026-07-28T09:41:00Z).
에러 형식
에러 응답은code, message와 선택적 details로 구성됩니다.
401, 크레딧 부족은 402(INSUFFICIENT_CREDITS), 요청 한도 초과는 429(PLATFORM_RATE_LIMIT_EXCEEDED)를 반환합니다. 전체 코드 목록과 재시도 전략은 에러 처리를 참고하세요.
기본 흐름
프로그래밍 방식으로 사용할 때의 호출 순서입니다.1
프롬프트 준비
POST /prompt-sets로 세트를 만들고 POST /prompts(또는 /prompts/bulk)로 질문을 등록합니다.2
수집 실행
POST /runs에 프롬프트(promptIDs 또는 promptSetID)와 모델(models)을 전달하면 runID가 반환됩니다.3
완료 폴링
GET /runs/{runID}의 status가 FINISHED가 될 때까지 30초 정도 간격으로 조회합니다. 수집은 보통 수 분 걸립니다.4
답변 조회
GET /answers?runID={runID}로 답변 본문(content), 인용 출처(sources), 검색 쿼리(fanouts)를 가져옵니다. promptSetID·model·from/to 필터로 분석 범위를 좁힐 수 있습니다.