빠른 시작

아래 순서를 따라 API 키 발급부터 첫 분석 요청, 결과 조회까지 전체 흐름을 경험해 보세요.

1. API 키 발급

MIRI 개발자 콘솔에 로그인한 뒤 API Keys 메뉴에서 Create API Key를 클릭하면 즉시 운영용 키가 발급됩니다. 키는 처음 표시될 때만 전체 값이 보이므로 안전한 곳에 저장하세요.

자세한 절차는 인증 가이드를 참고하세요.

2. 첫 분석 요청 보내기

/public/v1/analyses 엔드포인트로 POST 요청을 전송합니다.

curl -X POST https://open-miri-api.axistant.org/public/v1/analyses \
  -H "Miri-Api-Key: miri_live_sk_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "resumeData": {
      "type": "pdf",
      "content": "UEsDBBQABgAIAAAAIQAAAAAAAAAAAAAAAAAJAAAAdXJsLnR4dFxTZW5pb3IgcmVzdW1lIHNhbXBsZS4uLg=="
    },
    "jobPostingData": {
      "type": "html",
      "content": "PGgxPlNlbnRvciBCYWNrZW5kIEVuZ2luZWVyPC9oMT48cD7tj7zqsIDrp4jsnYAg7Yq4IOy0iOyGjC48L3A+"
    },
    "options": {
      "webhook": {
        "url": "https://partner.example.com/webhooks/analysis",
        "secret": "your-hmac-secret"
      }
    }
  }'

콘텐츠 인코딩

type: "text" 또는 "html" 필드는 UTF-8 텍스트를 사용하고, PDF/DOCX 파일은 base64로 인코딩하세요(위 예시는 설명을 위해 길이를 단축했습니다).

응답 (202 Accepted)

{
  "success": true,
  "data": {
    "id": "0199d5b8-3a2f-4f62-8f4d-9c4fdfb7c2a1",
    "status": "QUEUED",
    "estimatedTime": 30,
    "createdAt": "2025-09-19T10:15:23.456Z",
    "webhook": {
      "url": "https://partner.example.com/webhooks/analysis",
      "delivery": {
        "state": "PENDING",
        "lastAttemptAt": null,
        "lastStatusCode": null,
        "attemptCount": 0,
        "lastError": null
      }
    },
    "links": {
      "self": "/public/v1/analyses/0199d5b8-3a2f-4f62-8f4d-9c4fdfb7c2a1"
    },
    "metadata": {
      "creditsUsed": 1
    }
  },
  "message": null,
  "code": "SUCCESS",
  "metadata": null
}

data.links.self 값이 폴링할 때 사용할 표준 URL입니다. options.webhook을 설정한 경우 응답의 webhook 필드에서 현재 전달 상태를 즉시 확인할 수 있습니다.

3. 결과 조회

응답으로 받은 analysisId를 사용해 결과를 조회합니다.

curl https://open-miri-api.axistant.org/public/v1/analyses/{analysisId} \
  -H "Miri-Api-Key: miri_live_sk_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

status가 PROCESSING이라면 일정 시간 후 다시 조회하거나, 웹훅을 등록해 완료 알림을 받을 수도 있습니다.

완료 응답 (200 OK)

{
  "success": true,
  "data": {
    "id": "0199f6ac-5c23-41b0-904b-6b9f7c5f2c11",
    "status": "COMPLETED",
    "createdAt": "2025-09-19T10:15:23.456Z",
    "completedAt": "2025-09-19T10:16:45.123Z",
    "processingTime": 82031,
    "estimatedTime": null,
    "result": {
      "analysis": { /* 보기 편의를 위해 일부 생략 */ }
    },
    "metadata": {
      "creditsUsed": 1
    },
    "webhook": {
      "url": "https://partner.example.com/webhooks/analysis",
      "delivery": {
        "state": "SUCCESS",
        "lastAttemptAt": "2025-09-19T10:16:45.500Z",
        "lastStatusCode": 200,
        "attemptCount": 1,
        "lastError": null
      }
    },
    "links": {
      "self": "/public/v1/analyses/0199f6ac-5c23-41b0-904b-6b9f7c5f2c11"
    }
  },
  "message": null,
  "code": "SUCCESS",
  "metadata": null
}

다음 단계

• 상세 스키마는 분석 API에서 확인하세요.
• 요청 본문에 webhook 객체를 추가하면 완료 알림을 받을 수 있습니다.