# 선정적인 컨텐츠(NSFW) 탐지



이미지 한 장이 선정적·폭력적인(NSFW) 이미지일 가능성을 0~1 점수로 돌려줍니다.



인증: Authorization: Bearer $APICK_API_KEY

본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다.

인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다.



## POST /rest/nsfw_detection 응답 필드

- `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.

- `data.nsfw_score` (number): NSFW 이미지일 가능성 0~1. 1에 가까울수록 선정적·폭력적일 가능성이 높습니다.

- `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.

- `data.detail` (object): detail=1로 요청했을 때만 포함되는 세부 판정 값입니다. nsfw_score도 함께 들어 있습니다. 판정에는 nsfw_score를 기준으로 쓰세요.

- `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.

- `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.

- `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.

- `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.

- `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.

## API 요청: POST /rest/nsfw_detection



### 입력

- `image` (file, 필수): 분석할 이미지 파일입니다. JPG·PNG·WEBP를 지원하며, 파일 크기·해상도 제한은 요청 표를 확인하세요.

- `detail` (string, 선택): 세부 판정 결과를 응답에 포함할지 정합니다. 1은 포함, 0은 미포함(기본값)입니다. 포함하면 응답이 커지고 처리 시간이 늘어날 수 있습니다.



### 응답 명세

```json

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "nsfw_score": {
          "type": "number",
          "description": "NSFW 이미지일 가능성 0~1. 1에 가까울수록 선정적·폭력적일 가능성이 높습니다."
        },
        "success": {
          "type": "integer",
          "description": "처리 결과입니다. 1: 성공(과금), 0: 실패, 3: 시간 초과(과금 없음)."
        },
        "detail": {
          "type": "object",
          "description": "detail=1로 요청했을 때만 포함되는 세부 판정 값입니다. nsfw_score도 함께 들어 있습니다. 판정에는 nsfw_score를 기준으로 쓰세요."
        }
      },
      "description": "판정 결과"
    },
    "api": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean",
          "description": "요청을 정상 처리했는지 여부입니다."
        },
        "cost": {
          "type": "integer",
          "description": "이번 요청에서 차감된 포인트입니다."
        },
        "ms": {
          "type": "integer",
          "description": "처리 시간(밀리초)입니다."
        },
        "pl_id": {
          "type": "integer",
          "description": "결제 기록 번호입니다. 문의할 때 함께 알려 주세요."
        }
      },
      "description": "호출 공통 정보"
    }
  }
}

```

### 정적 응답 예시

```json

{
  "data": {
    "nsfw_score": 0.128645,
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 10,
    "ms": 60,
    "pl_id": 25759686
  }
}

```

### curl

```curl

curl --fail-with-body --request POST 'https://apick.app/rest/nsfw_detection' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./upload.jpg'

```

### Node.js (서버 ESM)

```javascript

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("./upload.jpg")]), "upload.jpg");
const response = await fetch("https://apick.app/rest/nsfw_detection", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

```

### python

```python

import os
import requests
parts = [
    ("image", ("upload.jpg", open("./upload.jpg", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/nsfw_detection",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

```

### php

```php

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('./upload.jpg'),
];
$curl = curl_init('https://apick.app/rest/nsfw_detection');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

```

## 사용 예시 1. 업로드 이미지 사전 검사

게시 전에 점수만 받아 자동 차단·검토·게시를 나눕니다.

```bash

curl --fail-with-body --request POST 'https://apick.app/rest/nsfw_detection' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./upload.jpg'

```

- `data.nsfw_score`가 정한 기준 이상이면 차단하거나 관리자 검토로 보내세요(예: 0.8 이상 차단, 0.4~0.8 검토).

## 사용 예시 2. 세부 판정 값까지 받기

검토 화면에 근거를 함께 보여 주려면 `detail=1`을 보냅니다.

```bash

curl --fail-with-body --request POST 'https://apick.app/rest/nsfw_detection' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@./upload.jpg' \
  --form-string 'detail=1'

```

- `data.detail`에 세부 판정 값이 담깁니다. 차단 기준은 `data.nsfw_score`로 판단하세요.

## 코드·오류

### 업무 실패 응답

입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요.

```json

{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}

```

## 상세 기능·요금

업로드 용량 제한: 50MB multipart/form-data 요청에 포함된 첨부 이미지 합계는 최대 50MB입니다. 제한을 초과하면 HTTP 413과 REQUEST_TOO_LARGE 오류가 반환되며 과금되지 않습니다. 이용 전 확인 게시판·리뷰·프로필 사진처럼 사용자가 올리는 이미지를 게시 전에 걸러낼 때 사용합니다. PNG·JPEG·WEBP·BMP 이미지를 받습니다. 점수를 어디서 끊을지는 서비스 성격에 맞춰 정하세요. 예를 들어 0.8 이상은 자동 차단, 0.4~0.8은 관리자 검토, 그 미만은 게시처럼 구간을 나누면 오탐을 줄일 수 있습니다. 실제 운영 이미지 몇십 장으로 점수 분포를 먼저 확인한 뒤 기준을 정하는 것을 권장합니다. 성공한 건당 10P입니다. 실패·시간 초과 응답은 과금되지 않습니다.

## 상세 요청

항목설정 메서드·주소POST https://apick.app/rest/nsfw_detection 인증 헤더Authorization: Bearer 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기

## 상세 응답

필드타입설명 dataobject판정 결과 nsfw_scorenumberNSFW 이미지일 가능성 0~1. 1에 가까울수록 선정적·폭력적일 가능성이 높습니다. detailobjectdetail=1로 요청했을 때만 포함되는 세부 판정 값입니다. nsfw_score도 함께 들어 있습니다. 판정에는 nsfw_score를 기준으로 쓰세요. successinteger처리 결과입니다. 1: 성공(과금), 0: 실패, 3: 시간 초과(과금 없음). apiobject호출 공통 정보 successboolean요청을 정상 처리했는지 여부입니다. costinteger이번 요청에서 차감된 포인트입니다. msinteger처리 시간(밀리초)입니다. pl_idinteger결제 기록 번호입니다. 문의할 때 함께 알려 주세요. 응답 예시 { "data": { "nsfw_score": 0.128645, "success": 1 }, "api": { "success": true, "cost": 10, "ms": 60, "pl_id": 25759686 } }

## 상세 코드·정책

오류와 대처 실패하면 data.error에 문구가 담기고 api.cost는 0입니다. HTTPdata.error대처 400파일 유형이 맞지 않습니다. 이미지 형식의 파일만 허용됩니다.이미지 파일인지, 손상되지 않았는지 확인하세요. 424첨부파일이 없습니다.파일 필드 이름을 image로 보냈는지 확인하세요. 424알 수 없는 이유로 실패했습니다.이미지를 JPEG 또는 PNG로 다시 저장해 한 번 더 요청하세요. 408처리 시간 초과로 실패했습니다.data.success가 3입니다. 잠시 후 다시 요청하세요.

## 상세 예제

호출 예시 같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다. JavaScript 예시 form-data 전체 예제 보기 Python 예시 form-data 전체 예제 보기
