API 개요 - ARGOS Identity

Omni API로 Review Ops Agent의 검토를 기존 시스템에 연결합니다. 검토 대상과 서류를 보내고, 출력 스키마대로 조립된 판정·데이터·근거를 받습니다.

Base URL

https://client-omni-api.argosidentity.com/v1

방화벽·프록시로 아웃바운드를 제한하는 환경에서는 client-omni-api.argosidentity.com의 HTTPS(443)를 허용 목록에 추가하세요.

모든 요청에 프로젝트 API 키를 x-api-key 헤더로 보냅니다. 키 발급과 재발급은 인증을 참조하세요.

curl "https://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: your-api-key-here"

키는 프로젝트 단위입니다. 다른 프로젝트의 리소스를 요청하면 403 OMNI_5001이 반환됩니다.

Project → Workflow → Profile → Folder → Item → Analysis

리소스	엔드포인트	비고
Project	`GET /projects/:projectId`	조회만. 생성·설정은 대시보드
Workflow	`GET /workflows/:workflowId`, `GET /workflows/:workflowId/summary`	조회만. 생성·수정은 대시보드
Profile	`POST` · `GET` · `PATCH` · `DELETE`	워크플로우 하위
Folder	`POST` · `GET` · `PATCH` · `DELETE`	프로파일 생성 시 기본 폴더 자동 생성
Item	`POST` · `GET` · `PATCH` · `DELETE`	파일 업로드 또는 텍스트·JSON
Analysis	`POST` · `GET 목록` · `GET 상세` · `DELETE` · `GET 리포트`	비동기 실행

조회 응답은 리소스 객체를 그대로 반환합니다. 래퍼 필드는 없습니다. 목록 응답은 count와 items를 가지며, 리소스에 따라 nextCursor가 추가됩니다.

{
  "id": "proj_75hgxoxamzn9",
  "name": "Demo",
  "status": "trial"
}

시각은 모두 ISO 8601 UTC(2026-09-09T08:41:12.000Z)입니다. 삭제는 204 No Content를 반환합니다.

에러 본문은 최상위에 code와 message를 둡니다. 분기는 code로 하고, message는 표시용으로만 쓰세요.

{
  "code": "OMNI_3004",
  "message": "Analysis not found"
}

필드	타입	설명
`code`	`string`	`OMNI_` 접두사 에러 코드
`message`	`string`	사람이 읽는 설명. 문구는 바뀔 수 있음. 500 계열은 `Internal server error`로 고정
`details`	`object \| array`	(선택) 요청 검증 실패 등 추가 정보가 있을 때만

상태	코드	설명
400	`OMNI_2101`	요청 본문·쿼리·업로드 파일이 형식 검증을 통과하지 못함. 위반 내용은 `message`에
401	`OMNI_4001`	`x-api-key` 헤더 누락
401	`OMNI_4005`	유효하지 않거나 폐기된 API 키
403	`OMNI_5001`	API 키가 속한 프로젝트의 리소스가 아님
404	`OMNI_30xx`	리소스 없음. 리소스별 코드는 아래 표
429	`OMNI_2004`	체험판 프로젝트의 일일 분석 한도(10회) 초과
500	`OMNI_6001`	서버 내부 오류. 잠시 후 재시도, 반복되면 문의

상태	코드	설명	발생 위치
404	`OMNI_3002`	프로젝트 없음	Project
404	`OMNI_3003`	워크플로우 없음	Workflow · Profile 생성/목록
404	`OMNI_3004`	분석 없음	Analysis · Report
404	`OMNI_3005`	프로파일 없음	Profile · Folder · Analysis
404	`OMNI_3006`	아이템 없음	Item
404	`OMNI_3009`	폴더 없음	Folder · Item
400	`OMNI_2106`	`file`과 `content` 둘 다 없음	Item 생성
400	`OMNI_2107`	`content`만 보낼 때 `type` 누락	Item 생성
409	`OMNI_2005`	프로파일 누적 업로드 용량(100MB) 초과	Item 생성
400	`OMNI_2105`	지원하지 않는 파일 형식, 또는 확장자와 실제 내용 불일치	Item 생성
400	`OMNI_2205`	파일 아이템의 `content` 수정 불가	Item 수정
400	`OMNI_2206`	기본 폴더 삭제 불가	Folder 삭제
400	`OMNI_2109`	아이템이 없거나 프로파일 소속이 아님	Analysis 실행
409	`OMNI_2201`	해당 프로파일에 진행 중인 분석 있음	Analysis 실행
400	`OMNI_2208`	완료되지 않은 분석의 리포트 요청	Report

각 엔드포인트 페이지의 에러 표에는 리소스별 코드만 적고, 공통 코드는 이 표를 가리킵니다.

목록 엔드포인트마다 방식이 다릅니다.

엔드포인트	방식	파라미터	다음 페이지
프로파일 목록, 폴더 목록	커서	`cursor`, `limit`(기본 10, 최대 100)	응답의 `nextCursor`를 `cursor`로 전달. `null`이면 끝
분석 목록	마지막 ID	`cursor`, `limit`(기본 20, 최대 50)	마지막 `items[].id`를 `cursor`로 전달. `count < limit`이면 끝
아이템 목록	없음	—	커서·페이지 크기 없이 폴더의 아이템을 한 번에 전부 반환

정렬은 공통으로 sort와 order(asc / desc)를 받고, 필드 목록은 각 페이지에 있습니다.

파일 형식과 처리 시간은 리소스 제한에 정리했습니다.