REST API · v1

API 문서

비동기 API로 인물 사진을 제출하고, 기존 크레딧 지갑을 공유하며, 모든 작업과 결제 내역을 추적하세요.

AI 가이드와 함께 앱 연동하기

이 프롬프트를 ChatGPT, Claude, Cursor 또는 코딩 도우미에 복사하세요. 사용 중인 기술 스택을 확인한 뒤 인증 정보 설정, 잔액 확인, 작업 제출, 결과 검증을 안내합니다.

API 키를 AI에 보낼 필요가 없습니다. 프롬프트 안내에 따라 직접 서버 환경에 키를 설정하세요.

전체 프롬프트 보기 / 직접 복사

# FAHR FACE API v1

당신은 나의 API 연동 도우미입니다. 내가 사용하는 언어로 이 비동기 인물 사진 나이 추정 API를 프로젝트에 연동하는 방법을 안내해 주세요. 아래 계약을 따라 주세요. 실제 문서 내용이 다르면 구현을 변경하기 전에 차이점을 설명해 주세요. 존재하지 않는 엔드포인트, SDK 또는 응답 필드를 만들어 내지 마세요.

먼저 내가 사용하는 언어, 프레임워크, 런타임 버전, 신규 프로젝트인지 기존 프로젝트인지, 호스팅 및 서버 사용 가능 여부, CLI 스크립트·백엔드 연동·웹 기능 중 필요한 것이 무엇인지 물어보세요. 프로젝트를 살펴볼 수 있다면 먼저 구조, 의존성, 작성 규칙을 확인하세요. 한 번에 작고 검증 가능한 단계 하나씩 안내하고, 내 운영체제에 맞는 명령어, 파일 위치, 예상 결과, 문제 해결 방법을 알려 주세요. 다음 단계로 넘어가기 전에 내 피드백을 기다리세요. 진행 순서는 인증 정보 설정 → 무료 잔액 확인 → 업로드 구현 → 작업 저장 및 상태 확인 → 결과와 결제 검증입니다. 실제 실행하지 않은 단계를 성공했다고 말하지 마세요.

기본 URL: https://fahrface.org. 문서: https://fahrface.org/developers; 키 생성: https://fahrface.org/settings/apikeys; 크레딧 충전: https://fahrface.org/pricing. 만료일이 설정된 소액 한도의 키를 만들도록 안내하세요. 필수 권한: face-age:write, face-age:read, credits:read; 사용 내역을 확인할 때만 usage:read가 필요합니다. 비밀 키는 한 번만 표시됩니다. 실제 비밀 키를 AI 채팅에 붙여 넣으라고 요청하지 마세요. 서버 전용 FAHRFACE_API_KEY 환경 변수를 사용하고, 로컬 비밀 정보 파일은 버전 관리에서 제외하세요. 비밀 키를 소스 코드, 로그, 브라우저 또는 모바일 코드에 넣거나 VITE_ 또는 NEXT_PUBLIC_ 접두사를 사용하지 마세요. 웹 프런트엔드는 자체 백엔드 프록시를 호출해야 합니다. 이 API는 브라우저 CORS 연동을 제공하지 않습니다.

모든 엔드포인트는 https://fahrface.org을 사용하며, Authorization: Bearer <FAHRFACE_API_KEY>를 포함합니다. JSON 응답에는 code, message, data가 포함되며, 성공 여부는 code=0으로 확인합니다. POST 요청은 multipart/form-data 형식이며, 필드는 정확히 두 개입니다. image에는 JPEG, PNG 또는 WebP 파일 하나를 첨부해야 하며, 최대 크기는 5 MiB이고 실제 파일 형식이 MIME과 일치해야 합니다. consent=appearance-age-2026-10-21도 포함해야 합니다. 원격 이미지 URL, JSON 이미지 페이로드, 일괄 처리 또는 추가 필드는 허용되지 않습니다. FormData를 사용할 때는 HTTP 클라이언트가 경계(boundary)를 포함한 Content-Type을 설정하도록 하세요. 업로드 전에 실제 사용자가 만 18세 이상이고, 본인의 사진이며, 처리에 동의한다는 점을 명시적으로 확인해야 합니다. 동의 항목을 미리 선택하거나 동의를 임의로 만들어서는 안 됩니다. 엔드포인트, 권한 범위 및 응답 예시:

POST /api/v1/face-age/jobs — face-age:write
GET /api/v1/face-age/jobs/JOB_ID — face-age:read
GET /api/v1/credits — credits:read
GET /api/v1/usage?page=1&pageSize=20 — usage:read

POST 202 / replay 200:
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

GET /api/v1/credits → data: available, reserved, testCost, priceVersion
GET /api/v1/usage → data: items, total, page, pageSize

멱등성: 생성 요청에는 Idempotency-Key가 필요합니다. 이 키는 ASCII 문자, 숫자, 밑줄 또는 하이픈으로 이루어진 16~128자여야 합니다(UUID 사용 가능). 사용자가 새 테스트를 하기로 한 경우에만 키를 한 번 생성하세요. 요청을 보내기 전에 해당 키를 정확한 원본 파일 바이트, MIME 및 동의 정보와 연결해 저장하세요. 같은 계정에서 같은 키와 입력을 사용하면 추가 결제 없이 기존 작업을 반환합니다. 같은 키로 다른 입력을 보내면 HTTP 409가 반환됩니다. 네트워크 시간 초과, 재시도 및 프로세스 재시작 시에도 기존 키와 파일을 재사용해야 합니다. 재시도 루프 안에서 UUID를 생성하지 마세요. 실패한 작업도 같은 키로 다시 요청하면 기존 작업이 반환됩니다. 사용자가 명시적으로 새 테스트를 요청한 경우에만 새 키를 사용하세요.

비동기 처리: 새 작업은 HTTP 202를 반환하고, 재요청은 HTTP 200을 반환합니다. data.id를 저장하세요. GET /api/v1/face-age/jobs/JOB_ID를 10~15초마다 호출해 상태를 확인하고, Retry-After 및 키별 요청 한도를 준수하세요. queued, processing, retrying은 완료 전 상태이고, succeeded와 failed는 최종 상태입니다. 성공 시 숫자 형식의 data.age(년 단위)와 data.billingStatus를 확인하고, 실패 시 data.error를 확인하세요. HF의 콜드 스타트로 처리에 몇 분이 걸릴 수 있습니다. 제한 시간은 20분이며, 활성 워커 임대(worker lease)가 있으면 처리 완료가 추가로 4분 늦어질 수 있고, 이후 예약된 복구 절차가 진행됩니다. 클라이언트의 대기 시간 초과가 서버 작업의 실패를 의미하지는 않습니다. 작업 ID를 보관하고 상태 확인을 이어갈 수 있도록 하세요. 비용이 발생하는 새 테스트를 만들지 마세요.

결제: 각 API 테스트에서는 1 크레딧을 예약합니다. 성공하면 요금이 확정되고, 최종 실패 시 한 번 환불됩니다. 웹사이트 테스트는 같은 지갑에서 10 크레딧이 차감됩니다. GET 조회는 무료지만 요청 한도에 포함됩니다. 먼저 GET /api/v1/credits의 data.available을 확인하세요. 이 값에는 이미 예약 금액이 반영되어 있으므로 data.reserved를 다시 빼지 마세요. 잔액 부족, 이미지 오류 또는 한도 초과로 생성 전에 거부된 요청에는 요금이 부과되지 않습니다. 계정 한도는 조회를 포함해 인증된 요청 분당 60회이며, 개별 키의 한도는 더 낮을 수 있습니다. 계정당 API 작업은 동시에 최대 두 개까지 실행할 수 있으며, 키에 따라 하나로 제한될 수 있습니다. 키 사용 한도에는 예약 금액과 성공적으로 결제된 금액이 포함되며, 환불되면 한도가 복구됩니다. 폐기되었거나 만료된 키로는 조회할 수 없습니다. 사용량 조회는 page/pageSize를 지원하며, pageSize의 최댓값은 100입니다.

오류: 요청이 완료되었는지만 보지 말고 HTTP 상태 코드와 message를 확인하세요. 400은 잘못된 요청·동의·멱등성 키, 401은 유효하지 않거나 만료 또는 폐기된 키, 403은 권한 범위 누락, 402는 크레딧 부족, 404는 작업이 없거나 다른 계정에 속함, 409는 입력 충돌, 413은 파일 크기 초과, 415는 형식 오류, 429는 요청·동시 처리·키 사용 한도 초과, 503은 서비스 이용 불가를 뜻합니다. 400/401/402/403/413/415는 설정이나 입력을 수정하고, 무작정 재시도하지 마세요. 409가 발생하면 원래 입력을 복구하세요. 사용자가 새 테스트를 하기로 한 경우에만 새 키를 사용하세요. 429가 발생하면 message를 확인하세요. 요청 또는 동시 처리 한도 초과라면 Retry-After에 따라 기다리고, 키 사용 한도 초과라면 한도 조정이 필요합니다. 네트워크 오류 또는 503은 지수형 백오프에 최대 횟수를 설정해 재시도하되, POST의 멱등성 키는 그대로 유지하세요. 상태 확인 중 오류가 발생해도 원래 작업 ID를 보관하세요.

승인 기준: 먼저 무료 잔액 조회를 실행하세요. 실제 업로드 전에, 사용자가 업로드할 수 있는 동의된 본인 사진을 보유하고 있는지 확인하고 크레딧 예약에 대해 설명하세요. 생성 요청에서 작업 ID가 반환되는지, 같은 입력과 키를 다시 사용하면 같은 ID가 반환되는지, 상태 조회가 최종 상태에 도달하는지, 성공 시 나이 결과와 정확히 한 번의 결제가 기록되는지, 새로고침 또는 재시작 후에도 상태 조회를 이어갈 수 있는지 확인하세요. 실제 요청을 수행할 잔액이나 권한이 없다면 로컬 또는 모의 검증 결과라고 솔직하게 알리세요. 실제 연동을 통과했다고 주장하지 마세요. 마지막에는 실행 방법, 환경 변수 이름, 변경한 파일 및 문제 해결 방법을 안내하세요. 실제 비밀 정보나 사진 내용을 절대 출력하지 마세요.

개인정보 및 이용 범위: 사진은 비공개로 임시 저장되며, 최종 처리 후 삭제됩니다. 24시간 보존 주기는 예외 상황에 대비한 기본 삭제 절차입니다. HF가 사진을 처리합니다. 앱에서는 이미지나 키를 로그에 남기지 말고 임시 파일을 정리해야 합니다. 결과는 사진 속 외모상 나이를 추정하는 것으로, 의학적 조언, 신원 확인 또는 나이 증명에 사용할 수 없습니다. v1에는 웹훅 콜백, 원격 이미지 URL 또는 일괄 처리 엔드포인트가 없습니다. 이를 임의로 만들어 내지 마세요. 먼저 사용 중인 기술 스택과 배포 환경을 물어본 뒤 첫 단계부터 안내하세요.

결제

API: 테스트 성공 시 크레딧 1개 사용. 웹사이트: 테스트당 크레딧 10개 사용. 두 서비스는 같은 지갑을 사용합니다. API 작업 생성 시 크레딧 1개가 예약되며, 최종 실패 시 한 번 반환됩니다.

필요한 권한을 포함해 Authorization: Bearer 헤더를 보내세요. 동일한 이미지 바이트를 재시도할 때는 같은 Idempotency-Key를 사용하세요. 다른 입력에 같은 키를 사용하면 HTTP 409가 반환됩니다. 조회에는 크레딧이 사용되지 않습니다.

엔드포인트

HTTP	권한
POST /api/v1/face-age/jobs	face-age:write
GET /api/v1/face-age/jobs/{id}	face-age:read
GET /api/v1/credits	credits:read
GET /api/v1/usage?page=1&pageSize=20	usage:read

작업 생성

이미지 파일 하나(JPEG, PNG 또는 WebP, 최대 5 MB)와 아래 동의 필드를 multipart/form-data로 보내세요. 동의한 성인만 본인의 사진을 제출할 수 있습니다. 원격 URL과 추가 매개변수는 허용되지 않습니다. 새로운 논리적 테스트에만 새 멱등성 키를 생성하세요.

# 새 테스트마다 한 번 생성해 저장하세요. 재시도할 때는 기존 키와 이미지로 아래 curl 명령만 실행하세요.
IDEMPOTENCY_KEY="$(uuidgen)"

curl -X POST 'https://fahrface.org/api/v1/face-age/jobs' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'image=@portrait.jpg' \
  -F 'consent=appearance-age-2026-10-21'

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "JOB_ID",
    "status": "queued",
    "age": null,
    "creditsCost": 1,
    "billingStatus": "reserved"
  }
}

결과 확인

생성 요청은 HTTP 202와 작업 ID를 반환합니다. 10–15초 간격으로 상태를 확인하세요. queued, processing, retrying은 처리 중 상태이고 succeeded와 failed는 최종 상태입니다. HF를 깨우는 데 몇 분이 걸릴 수 있습니다. 작업 제한 시간은 20분이며, 활성 워커 임대 상태에 따라 최종 복구가 최대 4분 더 지연될 수 있습니다.

curl 'https://fahrface.org/api/v1/face-age/jobs/JOB_ID' \
  -H "Authorization: Bearer $FAHRFACE_API_KEY"

오류 및 제한

응답은 code/message/data 형식을 사용합니다. HTTP 400: 잘못된 요청 또는 동의 오류, 401: 잘못되었거나 만료된 키, 403: 권한 부족, 402: 크레딧 부족, 404: 작업이 없거나 소유한 작업이 아님, 409: 입력 변경, 413/415: 이미지 크기 또는 형식 오류, 429: 요청·동시 작업·한도 초과, 503: 서비스 이용 불가입니다. Retry-After를 따르고 같은 멱등성 키를 재사용하세요. 재시도하기 전에 message를 확인하세요.

키는 최대 1년 이내에 만료되도록 설정해야 합니다. 한도에는 예약된 크레딧과 사용이 완료된 크레딧이 포함되며, 환불 시 한도가 복구됩니다. 계정당 분당 요청은 최대 60회, 활성 API 작업은 최대 2개까지 가능합니다.

인물 사진은 비공개 버킷에 임시 저장되며, 처리가 끝나면 삭제됩니다. 삭제가 누락되는 경우를 대비해 24시간 후 삭제되는 대체 수명 주기 정책도 적용됩니다. 사진은 HF에서 처리됩니다. 추정 결과는 의학적 조언, 신원 확인 또는 나이 증명이 아닙니다.