ShanHaiYin API Documentation

The API is intended for server-side integrations such as moderation queues, commerce support tools, evidence collection workflows, internal dashboards, plugins, and automated review scripts. API calls use the same ShanHaiYin point balance as the website and mini program, and results use the same report language, request references, and SHA-256 fingerprints.

If you only need to check files occasionally, the web interface is simpler. Use the API when your system needs to submit checks automatically, store results, or attach a report to a business record.

Sign in and open API access in your account. Each account can keep up to 10 active API keys. You can revoke a key at any time. The full key is shown only once when it is created, so copy it immediately into your server environment or secret manager.

Do not expose an API key in browser code, mini program packages, mobile apps, or public repositories. If a key is leaked, revoke it and create a replacement.

Every public API request must include an API key in the request headers. Recommended format:

Authorization: Bearer shy_live_your_key
Content-Type: application/json

For file uploads, your HTTP client usually sets the multipart boundary automatically. Send the authorization header with the file form:

Authorization: Bearer shy_live_your_key
Content-Type: multipart/form-data

The following header is also supported:

X-Shanhaiyin-Api-Key: shy_live_your_key

Audio and video shorter than one minute are billed as one minute. Additional time is rounded up to the next whole minute, based on the duration read by the server.

Request fields

Response example

{
  "ok": true,
  "provider": "shanhaiyin",
  "service": "image-aigc-detector",
  "requestId": "SHY-20260819-ABC12345",
  "riskLevel": "high",
  "modelScore": 96.5,
  "detected": true,
  "modelDecision": "Block",
  "results": [
    {
      "label": "aigc",
      "confidence": 96.5,
      "description": "The model found strong AI-generation or deepfake signals.",
      "riskLevel": "high"
    }
  ],
  "fileHash": "e3566ed2eb18...e0d7c03848",
  "detectedAt": "2026-08-19T08:00:00+00:00",
  "billing": {
    "charged": true,
    "channel": "api",
    "units": 1
  }
}

curl example

curl -X POST https://shanhaiyin.com/api/v1/images/analyze \
  -H "Authorization: Bearer shy_live_your_key" \
  -F "image=@/path/to/image.jpg"

Request example

{
  "text": "Paste the text you want to check here. The current limit is 350 to 2,000 characters."
}

Request fields

Response notes

The text endpoint returns synchronously. Its response follows the same core shape as image analysis and also includes textHash, textLength, and billingUnits.

curl example

curl -X POST https://shanhaiyin.com/api/v1/text/analyze \
  -H "Authorization: Bearer shy_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"text":"Paste the text you want to check here. The current limit is 350 to 2,000 characters."}'

Request fields

Job creation response example

{
  "ok": true,
  "status": "processing",
  "jobId": "9f1c4a2b3d4e5f60718293a4b5c6d7e8",
  "mediaKind": "audio",
  "durationSeconds": 73.42,
  "billingMinutes": 2,
  "retryAfter": 3,
  "billing": {
    "charged": true,
    "channel": "api",
    "units": 6
  }
}

curl example

curl -X POST https://shanhaiyin.com/api/v1/audio/analyze \
  -H "Authorization: Bearer shy_live_your_key" \
  -F "audio=@/path/to/audio.mp3"

Request fields

Job creation response example

{
  "ok": true,
  "status": "processing",
  "jobId": "9f1c4a2b3d4e5f60718293a4b5c6d7e8",
  "mediaKind": "video",
  "durationSeconds": 73.42,
  "billingMinutes": 2,
  "retryAfter": 3,
  "billing": {
    "charged": true,
    "channel": "api",
    "units": 16
  }
}

curl example

curl -X POST https://shanhaiyin.com/api/v1/video/analyze \
  -H "Authorization: Bearer shy_live_your_key" \
  -F "video=@/path/to/video.mp4"

Path parameters

Processing response example

{
  "ok": true,
  "status": "processing",
  "jobId": "9f1c4a2b3d4e5f60718293a4b5c6d7e8",
  "mediaKind": "video",
  "retryAfter": 3
}

Completed response example

{
  "ok": true,
  "provider": "shanhaiyin",
  "service": "video-aigc-detector",
  "requestId": "SHY-20260819-DEF67890",
  "providerTaskId": "w-video-aigc-xxx",
  "riskLevel": "high",
  "modelScore": 99,
  "detected": true,
  "modelDecision": "Block",
  "fileHash": "4f15e6d23d...87eaf894",
  "fileName": "video.mp4",
  "results": [
    {
      "label": "video_aigc",
      "confidence": 99,
      "description": "The model found strong AI-generated video-frame signals.",
      "riskLevel": "high"
    }
  ],
  "billing": {
    "charged": true,
    "channel": "api",
    "units": 16
  }
}

curl example

curl https://shanhaiyin.com/api/v1/media-status/9f1c4a2b3d4e5f60718293a4b5c6d7e8 \
  -H "Authorization: Bearer shy_live_your_key"

Error format

{
  "ok": false,
  "code": "INSUFFICIENT_POINTS",
  "message": "Your account does not have enough points for this image check."
}

API results are technical references. They should be reviewed together with source files, business records, publication context, and human judgment for high-stakes decisions.

Create an API key first, then make sure your point balance is sufficient. You can buy points from the recharge page.

Create an API key