Foundry REST API

Foundry REST API는 HTTP 엔드포인트로 Foundry 플랫폼의 리소스와 기능을 사용하는 인터페이스입니다. 애플리케이션은 데이터를 조회하거나 리소스를 관리하고, 온톨로지의 객체와 액션을 사용할 수 있습니다. 엔드포인트는 OAuth 2.0 인증을 사용하며 요청과 응답은 주로 JSON으로 표현합니다.

호출 준비

인증에서 개발용 사용자 토큰과 운영용 OAuth 흐름을 구분합니다.
첫 API 요청에서 실제 Foundry 호스트와 인증 정보를 사용하여 요청을 구성합니다.
SDK 선택에서 Platform SDK와 Ontology SDK의 적용 범위를 확인합니다.

공통 계약

페이지 나누기: 페이지 토큰, 요청한 페이지 크기와 실제 반환 건수, 스냅샷 일관성 및 전체 조회 한도를 설명합니다.
버전과 수명주기: 호환성을 깨는 변경, 같은 주 버전 안의 변경, 공개 프리뷰와 사용 중단 예고를 구분합니다.
요청 한도: 사용자별 요청 빈도와 동시 처리 제한을 설명합니다.
오류: 오류 이름, 코드, 발생 건 ID와 매개변수를 해석합니다.

객체 한 건 조회는 경로 매개변수, 선택적 속성, JSON 자료형과 인증을 함께 살펴볼 수 있는 엔드포인트입니다.

데이터를 외부 시스템으로 정기 전달하는 것이 목적이면 API를 직접 호출하는 방식과 Data Connection의 내보내기 기능을 비교합니다. API 요청과 데이터 연결 내보내기는 서로 다른 운영 경로이므로 전달 주기, 대상 시스템과 필요한 권한에 맞추어 선택합니다.

데이터셋 API

V1 데이터셋 API에서 데이터셋과 표 읽기, 브랜치, 트랜잭션 및 파일 작업을 선택할 수 있습니다. 각 엔드포인트에는 매개변수와 응답, cURL, Python, Java, JavaScript, PowerShell 요청 예제 및 개별 오류의 HTTP 상태가 있습니다.

V2 데이터셋 API는 스키마, 일정, 상태 검사와 실행 이력, View와 기반 데이터셋 및 기본 키 관리까지 포함합니다. 요청의 branchName, 브랜치 객체의 name 등 V1과 달라진 필드 이름을 구분하여 사용합니다.

미디어 집합 API

미디어 집합 API는 항목의 메타데이터와 콘텐츠를 조회하고 업로드, 등록 및 트랜잭션을 관리합니다. 이미지, 문서, 오디오와 비디오 등의 변환을 요청하고 작업 상태와 결과를 받을 수 있습니다. 임시 업로드의 보존 시간과 항목 읽기 토큰의 접근 범위도 함께 확인합니다.

외부 시스템 연결 API

Connectivity API는 외부 시스템의 연결 구성과 인증, 워커 및 내보내기 설정을 관리합니다. 원시 파일이나 SQL 조회 결과를 데이터셋으로 수집하고, 외부 테이블을 가상 테이블로 등록할 수 있습니다. 수집 구성의 생성과 실제 빌드 실행은 별도 작업입니다.

파일시스템과 프로젝트 API

Filesystem API는 리소스의 메타데이터와 휴지통 상태, 폴더, 프로젝트 및 공간을 관리합니다. 리소스 역할, 보안 표지와 조직 요구조건을 조회하거나 변경하고 프로젝트 사이의 참조를 구성할 수 있습니다. 휴지통 이동, 복원과 영구 삭제의 조건을 구분하여 사용합니다.

데이터 상태 검사 API

Data Health 검사 API는 검사 구성의 생성과 교체, 조회 및 삭제를 제공합니다. 보고서 API에서는 실행 당시의 구성과 결과를 확인합니다.

관리 API

V2 관리 API는 사용자와 그룹, 소속 관계와 만료 정책, 조직 및 역할 할당을 관리합니다. SSO 인증 제공자의 설정을 조회하고 첫 로그인 전에 사용자와 그룹을 등록하거나 외부 식별자 연결 정보를 관리할 수 있습니다. 플랫폼 인스턴스와 접속 호스트, 보안 표지 및 CBAC 분류의 배너와 조합 제약도 조회합니다.

감사와 체크포인트 API

감사 로그 API는 조직별 로그 파일을 날짜 범위로 찾고 각 파일의 본문을 다운로드합니다. Checkpoint 기록 API는 민감한 상호작용에서 제출한 사유나 확인 내용과 당시의 대상 스냅샷을 조회합니다.

민감 데이터 검사 기록 API

SDS 기록 API는 검사 구성과 공간을 기준으로 기존 검사 기록을 조회합니다. 실행 상태, 조건별 검사 행 수와 데이터셋 또는 미디어 집합의 일치 결과를 확인할 수 있습니다. 이 조회는 새 스캔이나 자동 대응을 시작하지 않습니다.

온톨로지 API

V1 온톨로지 API는 온톨로지와 유형 메타데이터, 첨부 파일, 액션 적용 및 검증, 쿼리 실행과 객체 조회, 검색 및 집계를 제공합니다.

지도 렌더링 API

지도 렌더링 API는 객체 집합의 지도 표현을 스냅샷으로 반환합니다. 클라이언트는 GeoJSON 도형, 래스터 타일과 스타일을 받아 화면에 표시하고, 일반 심볼을 PNG로 가져올 수 있습니다. 렌더링에는 버전이 없는 객체 집합의 RID를 사용합니다.

Functions 쿼리 함수 API

Functions API는 쿼리 함수의 메타데이터와 버전을 조회하고 함수를 실행합니다. 일반 실행은 JSON 결과 객체를, 스트리밍 실행은 SSE 이벤트를 반환합니다. 입력값의 JSON 표현, 함수 버전 선택과 온톨로지 범위를 구분하여 사용합니다.

실행 관측 API

리소스 실행 관측 API는 함수나 자동화의 완료된 실행을 조회합니다. 실행 시작 시각과 성공 여부, 실행 시간 등의 조건으로 검색하며, 반환한 추적 ID와 추적 문맥의 소유 리소스 RID를 함께 사용하여 실행 로그를 찾습니다.

언어 모델 프록시

언어 모델 프록시 API는 Anthropic Messages와 OpenAI Chat Completions, Responses 및 Embeddings 형식을 Foundry 인증과 데이터 거버넌스 안에서 사용합니다. 모델 RID, 사용량 귀속 및 추적 헤더와 Python/TypeScript SDK의 HTTP 클라이언트 조건을 함께 확인합니다.

AIP Chatbot API

AIP Chatbot API는 Chatbot Studio에서 만든 챗봇의 정의와 버전을 조회하고 대화 세션을 관리합니다. 응답 생성, 검색 컨텍스트 처리와 스트리밍 취소를 수행하며 대화 내용과 도구 호출 추적을 조회할 수 있습니다. 세션 조회 범위는 호출 사용자와 클라이언트에 따라 달라집니다.

SQL 쿼리 API

SQL 쿼리 실행과 결과 조회는 데이터셋 SELECT 쿼리 제출, 상태 조회, 취소와 Arrow/CSV 결과 수신을 설명합니다. 쿼리를 실행한 사용자에게만 허용되는 조작 범위, 쿼리 ID 인코딩 및 long polling 조건을 확인합니다.

Ontology SQL 실행은 객체 저장소를 대상으로 Arrow 결과를 동기 반환하는 프리뷰 API입니다. SQL 매개변수와 객체 집합 정의, 파생 속성, 문자열 및 공간 필터의 상세 자료형도 함께 제공합니다.