mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
5093c9667b
* Add deslop endpoint to Admin API spec * Document mint deslop CLI command * docs: add API reference page for deslop endpoint --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
32 lines
1.1 KiB
Plaintext
32 lines
1.1 KiB
Plaintext
---
|
|
title: "Detect AI-sounding prose"
|
|
openapi: /admin-openapi.json POST /v1/deslop/{projectId}
|
|
keywords: ["deslop", "AI detection", "slop", "prose", "content quality"]
|
|
---
|
|
|
|
This endpoint analyzes a documentation page for AI-generated prose and returns flagged passages with suggested human rewrites.
|
|
|
|
Authenticate with an [admin API key](/api/introduction#admin-api-key).
|
|
|
|
## Credits
|
|
|
|
- Consumes 1 AI credit per checked page.
|
|
- Pages under 50 words are skipped and not charged. The response returns `skipped: "too_short"` with `creditsCharged: 0`.
|
|
- If detection is temporarily unavailable, the endpoint returns `503` and no credit is charged.
|
|
|
|
## Response
|
|
|
|
Checked pages return a verdict (`predictionShort`), AI and human fractions, and a `windows` array of flagged passages. Each window includes a line range and a suggested rewrite.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
curl -X POST https://api.mintlify.com/v1/deslop/{projectId} \
|
|
-H "Authorization: Bearer mint_xxxxx" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"path": "guides/quickstart.mdx",
|
|
"content": "# Quickstart\n\nWelcome to our comprehensive documentation..."
|
|
}'
|
|
```
|