#
문서 생성 API 테스트 - 상세 문서
이 문서는 AI API 서비스의 **문서 생성 API 테스트**에 대한 상세 사용법과 기술 정보를 제공합니다.
##
1. API 개요
문서 템플릿을 기반으로 문서를 생성하는 API의 사용법을 테스트하고 관련 문서를 확인합니다. (프록시 API URL: /app-api/proxy/templates/{templateId}/generate)
이 API는 **개발자 지원 도구** 카테고리에 속하며, 주로 다음과 같은 업무 효율화 및 자동화에 기여할 수 있습니다:
- (여기에 구체적인 업무 기여 사항 기술)
- (예: 반복적인 데이터 입력 작업 시간 90% 단축)
- (예: 고객 문의 평균 응답 시간 5분 이내로 개선)
##
2. 엔드포인트 정보
- **프록시 엔드포인트 URL (백엔드 구성 시):** `https://aiapiservice.com/app-api/proxy/templates/{TEMPLATE_ID}/generate`
- **Genkit Flow 직접 호출 (현재 구현 방식):** 프론트엔드에서 직접 해당 Genkit Flow (`src/ai/flows/` 폴더 내)를 임포트하여 사용합니다. (단, 'document-template-usage' 또는 'query-document-templates' 서비스는 아래 해당 항목 참조)
- **HTTP Method:** POST (백엔드 프록시 API의 경우, 'query-document-templates'는 GET일 수 있음)
- **Content-Type:** `application/json` (백엔드 프록시 API의 경우)
- **인증:**
- 백엔드 프록시 API: `X-APP-API-KEY` 헤더에 유효한 앱 API 키를 포함해야 합니다. (계정 페이지에서 발급 가능)
- Genkit Flow 직접 호출: 일반적으로 서버 환경의 GOOGLE_API_KEY 또는 사용자가 제공한 API 키를 사용합니다. (플레이그라운드 UI 참고)
##
2.1. 문서 생성 API 엔드포인트 (document-template-usage)
- **엔드포인트:** `POST https://aiapiservice.com/app-api/proxy/templates/{templateId}/generate`
- **설명:** 이 엔드포인트를 사용하여 특정 문서 템플릿 ID (`{templateId}`)에 해당하는 문서를 생성합니다. 요청 본문에는 해당 템플릿의 플레이스홀더 키와 값들을 JSON 객체로 전달해야 합니다. 템플릿에 AI 연동이 설정된 경우, AI 처리된 최종 문서가 반환됩니다.
- **예시 요청 본문 (`{templateId}`가 'weekly-report-template-01'인 경우):**
```json
{
"reporterName": "홍길동",
"department": "개발팀",
"reportPeriodStart": "2024-07-01",
"reportPeriodEnd": "2024-07-07",
"completedTasks": "주요 업무 A 완료, 기능 B 개발 진행 중...",
"achievements": "목표 X 120% 달성",
"issuesAndSolutions": "이슈 Y 발생, 해결 방안 Z 검토 중",
"nextWeekPlans": "기능 C 개발 시작, 버그 수정",
"suggestions": "새로운 아이디어 제안..."
}
```
- **예상 응답 (성공 시):**
```json
{
"generatedDocumentHtml": "<!DOCTYPE html><html>...</html>", // 완성된 HTML 문서
"templateId": "weekly-report-template-01",
"usedPlaceholders": { /* 사용된 플레이스홀더 값들 */ }
}
```
##
3. 요청 파라미터 상세 (Genkit Flow Input Schema 또는 API 요청 본문)
문서 생성 API (`https://aiapiservice.com/app-api/proxy/templates/{templateId}/generate`)는 동적 요청 본문을 가집니다.
요청 본문의 각 키-값 쌍은 선택한 템플릿의 플레이스홀더 정의에 따라 달라집니다.
**각 템플릿의 플레이스홀더 정보는 "문서 생성 API 테스트" 플레이그라운드에서 해당 템플릿을 선택하면 확인할 수 있습니다.**
##
4. 요청 예시 (Genkit Flow 호출 시 TypeScript 객체 또는 API 요청 본문)
// 문서 생성 API 테스트 호출 예시
const input = {
// 이 API의 요청 본문은 선택된 템플릿에 따라 동적으로 결정됩니다.
// 위 "2.1. 문서 생성 API 엔드포인트" 항목의 예시를 참조하거나,
// "문서 생성 API 테스트" 플레이그라운드에서 템플릿 선택 후 확인하세요.
};
// const result = await yourFlowFunction(input); // Genkit Flow 직접 호출 시
// 또는 fetch('https://aiapiservice.com/app-api/proxy/...', { method: 'POST', body: JSON.stringify(input) }); // API 호출 시##
5. 응답 상세 (Genkit Flow Output Schema 또는 API 응답 본문)
성공적인 호출 시, 반환되는 객체는 다음과 같은 구조를 가질 수 있습니다:
(아래는 일반적인 예시이며, 실제 응답 구조는 각 Genkit Flow의 Output Schema 또는 API 정의를 따릅니다.)
// 예시: 문서 생성 API 테스트 응답 객체 타입
// type OutputType = {
// // API 종류에 따른 결과 데이터가 여기에 포함됩니다.
// // 예: generatedText?: string;
// // 예: summary?: string;
// // 예: imageUrl?: string;
// error?: string; // 오류 발생 시 메시지
// };실제 반환 타입은 해당 flow 파일의 OutputSchema 또는 백엔드 API 응답 스키마를 참조하세요.
##
6. 사용 사례 및 팁
- (여기에 해당 API의 구체적인 사용 사례, 비즈니스 활용 방안, 효과적인 사용 팁 등을 기술합니다.)
- (예: 고객 서비스 챗봇에 이 API를 연동하여 1차 문의 자동 응대율 70% 달성)
- (예: 대량의 법률 문서 검토 시간을 50% 이상 단축하여 변호사의 핵심 업무 집중도 향상)
##
7. 제한 사항 및 고려 사항
- (API 호출 빈도 제한, 입력 데이터 크기 제한, 지원 언어/파일 형식 등 기술적 제약사항 명시)
- (개인정보보호 관련 주의사항, 결과물의 정확성 및 편향성 문제 등 윤리적 고려 사항)
이 문서는 **2025년 5월 25일**에 마지막으로 업데이트되었습니다.
API는 지속적으로 개선되고 있으므로, 최신 정보는 항상 본 문서를 참조해주시기 바랍니다.
궁금한 점이나 기술 지원이 필요하시면 [AI API 서비스 지원팀](/contact)으로 문의해주세요.