> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bizmori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 주문 보고서 조회

> 보고서 상태와, `completed`일 때 다운로드 URL을 조회합니다. 생성 요청이 없던 locale은 `404 REPORT_NOT_FOUND`입니다.

`download.url`은 호출할 때마다 새로 서명되며 300초 뒤 만료됩니다. 만료된 URL은 저장소가 `403`을 반환하며 갱신할 수 없습니다. URL을 저장하지 말고, 사용자가 다운로드를 누를 때 이 API를 호출해 받은 URL로 바로 이동하세요.

주문의 보관 기한이 지나면 보고서 상태와 관계없이 `400 ORDER_EXPIRED`를 반환합니다.




## OpenAPI

````yaml ko/api-reference/openapi.yaml GET /api/v3/orders/{orderId}/reports/{locale}
openapi: 3.0.0
info:
  title: BIZ MORI API
  version: 2.0.0
  description: >
    BIZ MORI API는 디지털 콘텐츠 보호를 위한 네 가지 핵심 서비스를 제공합니다:

    - **Anti-AI**: 이미지를 AI 학습으로부터 보호

    - **Watermark Embed**: 이미지에 보이지 않는 디지털 워터마크 삽입

    - **Watermark Extract**: 이미지에서 워터마크 추출 및 검증

    - **AI Detection**: 이미지가 AI로 생성되었는지 감지

    - **테스트 API 키**: `sk_test_` 접두사의 키는 동일한 Bearer 인증을 사용하며, 실제 처리 서비스나 크레딧 사용
    없이 주문 흐름을 검증할 수 있습니다. 테스트 업로드는 파일 내용을 폐기하고 결과 파일을 만들지 않습니다
  contact:
    name: BIZ MORI 지원
    email: support@bizmori.com
  license:
    name: Proprietary
    url: https://docs.bizmori.com/legal/terms
servers:
  - url: https://api.bizmori.com
    description: 프로덕션
security: []
tags:
  - name: Anti-AI
    description: AI 학습 방지 이미지 보호 주문
  - name: Watermark Embed
    description: 워터마크 삽입 주문
  - name: Watermark Extract
    description: 워터마크 추출 주문
  - name: AI Detection
    description: AI 생성 이미지 감지 주문
  - name: Orders
    description: 주문 조회 및 관리
  - name: Webhooks
    description: 웹훅 설정 및 이벤트
  - name: Reports
    description: 워터마크 추출·AI Detection 주문의 PDF 분석 보고서
paths:
  /api/v3/orders/{orderId}/reports/{locale}:
    get:
      tags:
        - Reports
      summary: 주문 보고서 조회
      description: >
        보고서 상태와, `completed`일 때 다운로드 URL을 조회합니다. 생성 요청이 없던 locale은 `404
        REPORT_NOT_FOUND`입니다.


        `download.url`은 호출할 때마다 새로 서명되며 300초 뒤 만료됩니다. 만료된 URL은 저장소가 `403`을 반환하며
        갱신할 수 없습니다. URL을 저장하지 말고, 사용자가 다운로드를 누를 때 이 API를 호출해 받은 URL로 바로 이동하세요.


        주문의 보관 기한이 지나면 보고서 상태와 관계없이 `400 ORDER_EXPIRED`를 반환합니다.
      operationId: getOrderReport
      parameters:
        - in: path
          name: orderId
          required: true
          schema:
            type: string
            pattern: ^[0-9]{1,20}$
          description: 주문 ID
        - in: path
          name: locale
          required: true
          schema:
            type: string
            enum:
              - ko-KR
              - en-US
              - ja-JP
          description: 보고서 언어
      responses:
        '200':
          description: >-
            `queued`·`processing`·`completed`·`failed` 상태의 보고서. `download`는
            `completed`에서만 존재
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderReportResponse'
              example:
                data:
                  orderId: '1234567891'
                  reportType: watermarkDetection
                  locale: en-US
                  status: completed
                  download:
                    url: https://s3.ap-northeast-2.amazonaws.com/...
                    expiresInSeconds: 300
                  failure: null
        '400':
          description: 잘못된 요청, 주문 종류가 지원하지 않는 locale, 또는 보관 기한이 지난 주문
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation:
                  value:
                    code: VALIDATION_FAILED
                locale:
                  value:
                    code: REPORT_LOCALE_UNSUPPORTED
                expired:
                  value:
                    code: ORDER_EXPIRED
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: 주문이 없거나, 이 locale로 요청한 보고서가 없거나, 완료된 보고서 파일이 없음
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                order:
                  value:
                    code: ORDER_NOT_FOUND
                report:
                  value:
                    code: REPORT_NOT_FOUND
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          description: 보고서 생성을 일시적으로 사용할 수 없음
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: SERVICE_UNAVAILABLE
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >
            curl -X GET
            https://api.bizmori.com/api/v3/orders/ORDER_ID/reports/en-US \
              -H "Authorization: Bearer YOUR_API_KEY"
        - lang: javascript
          label: JavaScript
          source: >
            const orderId = 'ORDER_ID';

            const locale = 'en-US';

            const response = await
            fetch(`https://api.bizmori.com/api/v3/orders/${orderId}/reports/${locale}`,
            {
              headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
            });

            const { data } = await response.json();

            if (data.status === 'completed') window.location.href =
            data.download.url;
        - lang: python
          label: Python
          source: |
            import requests

            order_id = 'ORDER_ID'
            locale = 'en-US'
            response = requests.get(
                f'https://api.bizmori.com/api/v3/orders/{order_id}/reports/{locale}',
                headers={'Authorization': 'Bearer YOUR_API_KEY'}
            )
            data = response.json()['data']
            if data['status'] == 'completed':
                pdf = requests.get(data['download']['url']).content
components:
  schemas:
    OrderReportResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/OrderReportResource'
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: 에러 코드
    OrderReportResource:
      type: object
      required:
        - orderId
        - reportType
        - locale
        - status
        - download
      properties:
        orderId:
          type: string
          description: 주문 ID
        reportType:
          type: string
          enum:
            - watermarkDetection
            - aiDetection
          description: BIZ MORI가 주문 종류로 결정
        locale:
          type: string
          enum:
            - ko-KR
            - en-US
            - ja-JP
        status:
          type: string
          enum:
            - queued
            - processing
            - completed
            - failed
          description: 보고서 생성 상태
        download:
          nullable: true
          description: 다운로드 정보. `status`가 `completed`일 때만 존재
          allOf:
            - $ref: '#/components/schemas/OrderReportDownload'
        failure:
          nullable: true
          description: 실패 정보. `status`가 `failed`일 때만 존재
          allOf:
            - $ref: '#/components/schemas/OrderReportFailure'
    OrderReportDownload:
      type: object
      required:
        - url
        - expiresInSeconds
      properties:
        url:
          type: string
          format: uri
          description: >
            300초 동안 유효한 PDF 서명 URL. 워터마크 보고서는 `<주문명>-report-<locale>.pdf` 이름으로
            저장됩니다(예: `봄 캠페인-report-ko-KR.pdf`).

            URL을 저장하지 말고 새 URL이 필요할 때 보고서 API를 다시 호출하세요.
        expiresInSeconds:
          type: integer
          enum:
            - 300
    OrderReportFailure:
      type: object
      required:
        - code
        - retryable
      properties:
        code:
          type: string
          enum:
            - REPORT_GENERATION_FAILED
            - REPORT_NOT_AVAILABLE
        retryable:
          type: boolean
          description: >
            `true`이면 같은 주문·locale로 `POST /api/v3/orders/{orderId}/reports`를 다시
            호출해 새로 생성할 수 있습니다.

            워터마크 보고서는 실패가 3회에 도달하면 `false`입니다.
  responses:
    Unauthorized:
      description: 인증 실패
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: AUTH_NOT_AUTHENTICATED
    InternalError:
      description: 내부 서버 오류
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: SERVER_INTERNAL_ERROR
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        외부 클라이언트 접근을 위한 Bearer API 키. 일반 키는 `sk_` 접두사를 사용하고, 테스트 키는 `sk_test_`
        접두사로 모의 응답을 사용해 실제 처리나 크레딧 사용 없이 주문 흐름을 검증합니다.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.