Loafacto Hub 문서

Appearance

Loafacto 문서/참고 문서/backend-server 문서/Backend Server API Endpoints

Backend Server API 엔드포인트 ​

백엔드 라우트는 프런트엔드 기능 호출, 에이전트 실행, 검색 처리, 운영 점검을 위해 구성됩니다.

공통 규칙 ​

  • Base URL: /api
  • 인증: Bearer 토큰 또는 프로젝트 단위 세션 토큰
  • 응답 포맷: JSON
  • 에러 코드: HTTP 표준 코드 + 서버 내부 코드

공통 응답 형식(예시) ​

json
{
  "success": true,
  "data": {},
  "error": null,
  "traceId": "req_01H..."
}

주요 라우트 ​

Health / Diagnostics ​

  • GET /api/health
    • 서버 상태, DB/벡터 서비스 연결 상태
  • GET /api/ready
    • 준비 상태(의존성 통과 여부) 확인

프로젝트 및 문서 ​

  • GET /api/projects
    • 프로젝트 목록 조회
  • GET /api/projects/:id
    • 프로젝트 상세 조회
  • POST /api/projects
    • 새 프로젝트 생성
  • PATCH /api/projects/:id
    • 프로젝트 정보 수정
  • GET /api/documents
    • 프로젝트 문서 목록 조회
  • POST /api/documents/upload
    • 문서 업로드(메타데이터 포함)
  • GET /api/documents/:id
    • 문서 상태/메타 조회
  • DELETE /api/documents/:id
    • 문서 삭제

Agent ​

  • POST /api/agent/execute
    • 에이전트 실행 요청
  • GET /api/agent/status/:jobId
    • 실행 상태 조회
  • POST /api/agent/cancel/:jobId
    • 실행 취소 요청
  • GET /api/agent/history
    • 실행 이력 조회
  • POST /api/rag/ingest
    • 문서 RAG 인덱싱 시작
  • GET /api/rag/ingest/:jobId
    • 인덱싱 작업 상태 조회
  • POST /api/rag/search
    • 질문 기반 검색
  • POST /api/rag/reindex
    • 문서 재색인 트리거

상태 코드 가이드 ​

  • 200 : 성공
  • 201 : 생성 완료
  • 202 : 비동기 작업 수락
  • 400 : 파라미터/요청 형식 오류
  • 401 : 인증 실패
  • 403 : 권한 없음
  • 404 : 리소스 미존재
  • 409 : 충돌(상태 간 충돌 등)
  • 429 : 요청 제한 초과
  • 500 : 서버 처리 실패