개발자 문서/프로젝트별 연동 지시문

프로젝트별 연동 지시문

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

GET/rest/subagent/v1/status전체 10개 경로
요청 예제로 이동 ↓

기능·제공 범위

인증
Bearer 키
요청
form-data / GET
응답
JSON

빠른 시작

서버의 APICK_API_KEY를 준비하고 입력값을 바꾸세요. 아래에서 경로별 입력·응답·실행 환경을 함께 확인할 수 있습니다.

요청과 응답

1. 상태·목록 조회
GET/rest/subagent/v1/status

Bearer 인증 · 요청 본문 없음 · JSON 응답

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

2. 작업 접수
POST/rest/subagent/v1/jobs

Bearer 인증 · multipart/form-data · JSON 응답

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

3. API 요청
POST/rest/subagent/v1/files

Bearer 인증 · multipart/form-data · JSON 응답

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

4. API 요청
POST/rest/subagent/v1/files/:file_id/parts

Bearer 인증 · multipart/form-data · JSON 응답

경로의 file_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_FILE_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

5. API 요청
POST/rest/subagent/v1/files/:file_id/complete

Bearer 인증 · multipart/form-data · JSON 응답

경로의 file_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_FILE_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

6. 상태·목록 조회
GET/rest/subagent/v1/jobs/:job_id

Bearer 인증 · 요청 본문 없음 · JSON 응답

경로의 job_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_JOB_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

7. API 요청
POST/rest/subagent/v1/jobs/:job_id/evidence

Bearer 인증 · multipart/form-data · JSON 응답

경로의 job_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_JOB_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

8. API 요청
POST/rest/subagent/v1/jobs/:job_id/review

Bearer 인증 · multipart/form-data · JSON 응답

경로의 job_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_JOB_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

9. 작업 취소
POST/rest/subagent/v1/jobs/:job_id/cancel

Bearer 인증 · multipart/form-data · JSON 응답

경로의 job_id는 앞 단계에서 받은 값으로 바꾸세요. 예제는 해당 값을 APICK_JOB_ID 환경변수에서 읽습니다.

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

10. 상태·목록 조회
GET/rest/subagent/v1/usage

Bearer 인증 · 요청 본문 없음 · JSON 응답

입력 항목

추가 폼 항목이 없습니다. 인증 헤더는 필요합니다.

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

공개된 정적 응답 예제가 없는 경로입니다. 필드 명세에서 제공 범위를 확인하세요.

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

응답 상세

경로별 응답 예시와 필드 명세는 위 API 요청 설명에 붙어 있습니다. JSON을 파일로 저장하기 전에는 Content-Type과 오류를 확인하세요.

상태·오류·재시도

HTTP 상태 → API 처리 여부 → 업무 상태 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

공통 폼 입력 오류

FORM_DATA_INVALID · HTTP 400: 필드 이름·타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.

FORM_DATA_FIELD_CONFLICT · HTTP 400: 같은 값과 중첩 경로를 동시에 지정하지 마세요.

MULTIPART_LIMIT_OR_PARSE_ERROR · HTTP 400/413: boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·제한·이용 조건

기능·제공 범위·요금·제한 전체 보기

에이픽 서브에이전트

조사·추출·요약·비교를 위임하고, 원문 인용과 해시로 검수합니다.

각 프로젝트에 전달할 연동 지침에서 복사해 사용하는 지시문, Windows·macOS·Linux API 키 설정, 첫 무료 확인, 프로젝트별 파일 범위, 실제 위임·근거 검수와 오류 대응을 확인하세요. 지침 파일 내려받기

Node.js 22.17 이상에서 설치합니다. Codex·Claude Code 설정의 기존 항목은 보존합니다.

npm install -g apick-subagent
apick-subagent install
# APICK_API_KEY 환경변수에 apick.app API 키를 설정한 뒤 클라이언트 재시작
apick-subagent doctor

프로젝트 폴더를 열고 “이 자료의 비교를 apick-subagent에 위임하고 핵심 근거를 검수해 줘”라고 요청하세요. 설치만으로 모든 요청의 위임이 강제되지는 않습니다. 작업에 맞는 위임 여부는 주 에이전트가 판단합니다.

배포 파일로 직접 설치할 수도 있습니다: npm install -g https://apick.app/downloads/apick-subagent-1.0.1.tgz

모든 요청에 Authorization: Bearer API_KEY가 필요합니다. 접수에는 Idempotency-Key를 보내세요. 같은 키와 같은 내용은 기존 작업을 반환하며, 다른 내용은 409 오류입니다. 연결 종료는 작업 취소가 아닙니다.

메서드
경로
설명
GET
/rest/subagent/v1/status
접수 상태·잔액·지원 작업
POST
/rest/subagent/v1/files
상대경로 path, bytes, sha256, retention으로 업로드 시작
POST
/rest/subagent/v1/files/{file_id}/parts
part_no(0부터), base64 data를 반환된 part_bytes 크기로 순서대로 업로드
POST
/rest/subagent/v1/files/{file_id}/complete
전체 크기·해시·텍스트 검증 후 파일 준비
DELETE
/rest/subagent/v1/files/{file_id}
원문·관련 결과·캐시 즉시 삭제, 처리 중 작업 취소
POST
/rest/subagent/v1/jobs
kind, goal, file_ids, focus, acceptance, retention으로 접수
GET
/rest/subagent/v1/jobs/{job_id}
상태·결과·결과 해시, cursor로 다음 결과 조회
POST
/rest/subagent/v1/jobs/{job_id}/evidence
evidence_ids로 원문 인용·줄 번호·해시 조회
POST
/rest/subagent/v1/jobs/{job_id}/review
result_hash와 decision(accepted 또는 rejected) 기록
POST
/rest/subagent/v1/jobs/{job_id}/cancel
작업 취소. 원가 미확정이면 정산 확인을 기다립니다.
DELETE
/rest/subagent/v1/jobs/{job_id}
결과·근거·캐시 삭제
GET
/rest/subagent/v1/usage
호출·토큰·캐시·과금·최근 작업
curl https://apick.app/rest/subagent/v1/status \
  -H "Authorization: Bearer $APICK_API_KEY"

curl -X POST https://apick.app/rest/subagent/v1/jobs \
  -H "Authorization: Bearer $APICK_API_KEY" \
  -H "Idempotency-Key: project-review-20261004-001" \
  -H "Content-Type: application/json" \
  -d '{"kind":"compare","goal":"문서 두 개의 차이와 충돌을 비교하세요","file_ids":["업로드 완료한 파일 ID"],"focus":[],"acceptance":["모든 주장에 원문 근거"],"retention":"seven_days"}'

kind는 inventory, extract, summarize, compare 중 하나입니다. 큰 자료는 자동 분할합니다. 파일 수·토큰·누적 사용액의 상품 한도는 없으며, 전송 조각과 응답 페이지 크기는 안정적인 처리를 위한 단위입니다.

원격 주소는 https://apick.app/mcp/subagent입니다. Bearer 인증을 지원하는 Streamable HTTP 클라이언트에서 연결하세요. 원격 MCP는 이미 업로드한 자료를 처리합니다. 로컬 파일 직접 수집은 설치 패키지의 브리지가 담당합니다.

도구
기능
apick_status
상태·잔액 확인
apick_dispatch
멱등 작업 접수
apick_collect
짧은 결과와 다음 페이지 확인
apick_evidence
근거 조회
apick_review
결과 해시에 검수 기록
apick_cancel
작업 취소
apick_usage
내 사용 통계

성공한 작업의 확인된 사용 원가에 40%를 가산합니다. 소수 포인트는 누적하며, 승인된 동일 결과 캐시 재사용은 0P입니다. 접수 시 예상 최대 비용을 예약하고 차액을 해제합니다. 실패·취소·자동 검증 실패는 청구하지 않습니다. 비용 미확정이 24시간 지속되면 예약을 해제합니다.

자료는 7일 후 만료됩니다. retention을 none으로 보내면 검수 완료 후 삭제하며, 임시 보관은 최대 1시간입니다. 즉시 삭제도 가능합니다. 주 모델 실제 비용 미연동은 0원이나 확정 절감률로 표시하지 않습니다.

코드
대응
AUTH_REQUIRED
키·계정·허용 IP 확인
INSUFFICIENT_POINTS
포인트 충전 후 다시 접수
IDEMPOTENCY_CONFLICT
기존 요청 내용 확인. 응답 유실에는 같은 키·같은 내용을 유지
INTEGRITY_FAILED
자료·근거 검증 실패. 청구하지 않으며 상태 확인 후 내용 검토
UNAVAILABLE
기존 작업 ID로 상태 확인. 새 키로 무작정 재접수하지 않음
EXPIRED
자료 보관 기간 종료. 필요한 자료를 다시 업로드

사용량·비용 확인 · 제품 소개와 검증 사례

요약은 목표와 관련된 원문 인용을 출처별로 묶습니다. 비교는 동일 문구와 자료별 고유 문구를 구분합니다. 자동 근거 검증은 인용·행·해시 일치 검사이며 의미 판단과 최종 결론은 주 에이전트가 검수합니다.

연동 시 확인할 내용

예제는 경로별로 최소 요청과 오류 처리 포함 모드를 제공합니다. 실제 사용 환경의 시간 제한·취소·업무 성공 판정을 적용하세요.

개발가이드 검색

필요한 API와 이용 요금을 함께 확인하세요.

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