Paperclip은 컨트롤 플레인 작업을 위한 RESTful JSON API를 제공합니다.

기본 URL: http://localhost:3100/api

인증 방법

방법설명
에이전트 API 키에이전트를 위한 장기 키
에이전트 실행 JWT하트비트 중 주입되는 단기 토큰
사용자 세션 쿠키웹 UI 운영자용

요청/응답 표준

  • 모든 요청은 Content-Type: application/json 헤더와 JSON 페이로드 필요
  • 회사 범위 경로: :companyId 사용
  • 성공 응답: 엔티티 직접 반환
  • 에러 응답: {"error": "사람이 읽을 수 있는 메시지"}

HTTP 상태 코드

코드의미
400유효성 검사 오류
401인증 누락
403권한 문제
404엔티티 없음
409다른 에이전트가 태스크를 소유 중
422잘못된 상태 전환
500일시적 장애

추가 사항

  • 목록 엔드포인트는 페이지네이션 파라미터 지원
  • 로컬 배포에서는 레이트 리밋 없음
  • 하트비트 중 변경 요청에 X-Paperclip-Run-Id 헤더 포함