Lynx는 공개 런타임 계약을 OpenAPI 3.0 JSON 문서로 제공합니다.
스키마 경로는 공개되어 있어 API 키 없이 조회할 수 있습니다. 스키마에
정의된 실제 API를 호출할 때는 각 작업에 표시된 워크스페이스 API 키
권한이 필요합니다.
문서에는 다음 정보가 포함됩니다.
- 실제 API와 같은 Zod DTO에서 생성한 요청 및 응답 스키마
X-API-Key 인증 정보- 작업별 필요 권한을 나타내는
x-required-scopes 확장 필드
- 경로, 쿼리, 필수 SDK 헤더
- Python, Go 등에서 활용할 수 있는 안정적인
operationId
- 공통 오류와 요청 제한 응답
클라이언트 생성
lynx-openapi.json을 OpenAPI 3 호환 생성 도구에 전달합니다. 생성된
전송 코드는 API 키, 이벤트 배치, 재시도, 로컬 저장, 방화벽 정책 판단을
담당하는 작은 Lynx 전용 레이어 뒤에서 사용하는 것을 권장합니다.
생성된 클라이언트는 HTTP 계약만 제공합니다. Run 컨텍스트 전달,
백그라운드 전송, 크기가 제한된 큐, 로컬 방화벽 판단, 승인 조회 제한
시간, flush(), shutdown()은 별도로 구현해야 합니다.
호환성
문서는 상대 서버 URL /openapi/v1을 사용합니다. 대화형 API 도구는
openapi.json을 제공한 도메인을 그대로 사용합니다. 코드 생성 도구에서
환경별 Lynx 도메인으로 변경할 수도 있습니다.
작업이나 필드를 제거하거나 새로운 필수 필드를 추가하는 변경은 호환성을
깨뜨립니다. 선택 필드와 새로운 작업을 추가하는 변경은 기존
클라이언트와 호환됩니다.
생성된 클라이언트도 연결 프로그램이 전달한 프롬프트, 도구 인자, 모델 응답,
로그, payload를 전송합니다. 보내기 전에 민감정보를 마스킹하고, 생성된 디버그
로그에 워크스페이스 API 키가 남지 않게 합니다.
