Detect AI-sounding prose

POST

deslop

{projectId}

Detect AI-sounding prose in a page

curl --request POST \
  --url https://api.mintlify.com/v1/deslop/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "content": "<string>"
}
'

import requests

url = "https://api.mintlify.com/v1/deslop/{projectId}"

payload = {
    "path": "<string>",
    "content": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', content: '<string>'})
};

fetch('https://api.mintlify.com/v1/deslop/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/deslop/{projectId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/deslop/{projectId}"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mintlify.com/v1/deslop/{projectId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/deslop/{projectId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "creditsCharged": 123,
  "fractionAi": 123,
  "fractionAiAssisted": 123,
  "fractionHuman": 123,
  "windows": [
    {
      "text": "<string>",
      "label": "<string>",
      "aiAssistanceScore": 123,
      "startLine": 123,
      "endLine": 123,
      "confidence": "<string>",
      "rewrites": [
        {
          "text": "<string>",
          "rationale": "<string>"
        }
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

This endpoint analyzes a documentation page for AI-generated prose and returns flagged passages with suggested human rewrites. Authenticate with an 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

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..."
  }'

Authorizations

Authorization

string

header

required

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

Path Parameters

projectId

string

required

Your project ID. Can be copied from the API keys page in your dashboard.

Body

application/json

path

string

required

Repo-relative path of the page, used for reporting only.

Minimum string length: 1

content

string

required

The raw MDX or Markdown content of the page to check.

Minimum string length: 1

Response

The page was checked, or skipped because it was too short.

path

string

required

The path from the request.

skipped

enum<string> | null

required

Reason the page was skipped, or null when the page was checked. too_short means the page had fewer than 50 words of prose and was not charged.

Available options:

too_short,

null

creditsCharged

integer

required

AI credits charged for this request (0 when skipped).

predictionShort

enum<string>

Overall verdict for the page. Present only when the page was checked.

Available options:

AI,

AI-Assisted,

Human,

Mixed

fractionAi

number

Fraction of the page detected as AI-generated (0-1).

fractionAiAssisted

number

Fraction detected as AI-assisted (0-1).

fractionHuman

number

Fraction detected as human-written (0-1).

windows

object[]

Flagged (non-human) passages. Present only when the page was checked.

Show child attributes

Trigger automation

Create agent job

⌘I

Detect AI-sounding prose in a page

curl --request POST \
  --url https://api.mintlify.com/v1/deslop/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "content": "<string>"
}
'

import requests

url = "https://api.mintlify.com/v1/deslop/{projectId}"

payload = {
    "path": "<string>",
    "content": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', content: '<string>'})
};

fetch('https://api.mintlify.com/v1/deslop/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/deslop/{projectId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/deslop/{projectId}"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mintlify.com/v1/deslop/{projectId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/deslop/{projectId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "path": "<string>",
  "creditsCharged": 123,
  "fractionAi": 123,
  "fractionAiAssisted": 123,
  "fractionHuman": 123,
  "windows": [
    {
      "text": "<string>",
      "label": "<string>",
      "aiAssistanceScore": 123,
      "startLine": 123,
      "endLine": 123,
      "confidence": "<string>",
      "rewrites": [
        {
          "text": "<string>",
          "rationale": "<string>"
        }
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API reference

Admin

Agent

Assistant

Analytics

Static export

Detect AI-sounding prose

Credits

Response

Usage

Authorizations

Path Parameters

Body

Response

​Credits

​Response

​Usage

Authorizations

Path Parameters

Body

Response

Credits

Response

Usage