reopt Handbook 개발자 포털

인증과 API 키

공개 검색, 문서 조회, 챕터 목록, 그래프 API는 로그인이나 API 키 없이 사용할 수 있습니다. API 키 발급 기능은 제공하지 않습니다. 개인 책장은 로그인 세션이 필요하고 공개 조회 API에 포함되지 않습니다. 문서 수정과 AI 실행은 이 공개 통합 안내의 대상이 아닙니다.

빠른 시작

먼저 검색 결과의 URL로 핸드북을 고르세요. /api/docs/{slug}는 content, path, modifiedAt을 반환합니다. slug에는 책 이름 또는 책/챕터 경로를 넣습니다. locale=ko 또는 locale=en으로 언어를 선택할 수 있습니다. 검색 결과가 없으면 빈 배열이 반환됩니다.

읽기 전용 API 테스트

아래 예제는 실제 공개 데이터를 조회하는 GET 요청입니다. 링크를 열어 JSON 응답을 확인할 수 있으며 계정이나 문서를 변경하지 않습니다. 별도의 격리된 샌드박스는 제공하지 않습니다. 검색 limit은 기본 20이며 최대 100개까지 반환합니다.

• /api/search?query=agent&locale=ko&limit=3

  curl -sS 'https://handbook.reopt.ai/api/search?query=agent&locale=ko&limit=3'

• /api/docs/agentic-mvp?locale=ko

  curl -sS 'https://handbook.reopt.ai/api/docs/agentic-mvp?locale=ko'

• /api/home-books/chapters/agentic-mvp?locale=ko

  curl -sS 'https://handbook.reopt.ai/api/home-books/chapters/agentic-mvp?locale=ko'

• /api/graph?locale=ko

  curl -sS 'https://handbook.reopt.ai/api/graph?locale=ko'

오류 처리

공개 REST API의 오류는 application/problem+json 형식입니다. HTTP 상태와 status를 확인하고 code로 분기하세요. detail과 기존 error 필드는 오류 설명이며 resolution은 해결 방법입니다. 400은 요청 형식, 404는 경로를 확인하고, 500은 잠시 후 재시도하세요. 존재하지 않는 /api 경로도 JSON 오류를 반환합니다.

MCP와 Markdown

MCP 클라이언트는 /api/mcp의 Streamable HTTP 전송을 사용합니다. 인증은 필요하지 않습니다. MCP는 REST 오류 형식이 아닌 자체 JSON-RPC 프로토콜을 따릅니다. 문서는 Accept: text/markdown으로 요청하거나 llms.txt의 내보내기 링크를 사용하세요. API와 콘텐츠의 재사용 조건은 서비스 약관을 확인하세요.