Skip to main content
POST
Detectar prosa que suena a IA en una página
Este endpoint analiza una página de documentación en busca de prosa generada por IA y devuelve los pasajes marcados con reescrituras humanas sugeridas. Autentícate con una clave de API de administrador.

Créditos

  • Consume 1 crédito de IA por página comprobada.
  • Las páginas con menos de 50 palabras se omiten y no se cobran. La respuesta devuelve skipped: "too_short" con creditsCharged: 0.
  • Si la detección no está disponible temporalmente, el endpoint devuelve 503 y no se cobra ningún crédito.

Respuesta

Las páginas comprobadas devuelven un veredicto (predictionShort), fracciones de IA y humana, y un arreglo windows de pasajes marcados. Cada window incluye un rango de líneas y una reescritura sugerida.

Uso

Autorizaciones

Authorization
string
header
requerido

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Parámetros de ruta

projectId
string
requerido

El ID de tu proyecto. Se puede copiar desde la página de claves de API en tu panel de control.

Cuerpo

application/json
path
string
requerido

Ruta de la página relativa al repositorio, utilizada solo para informes.

Minimum string length: 1
content
string
requerido

El contenido MDX o Markdown sin procesar de la página que se va a comprobar.

Minimum string length: 1

Respuesta

La página se comprobó, o se omitió porque era demasiado corta.

path
string
requerido

La ruta proveniente de la solicitud.

skipped
enum<string> | null
requerido

Motivo por el que se omitió la página, o null cuando la página se comprobó. too_short significa que la página tenía menos de 50 palabras de prosa y no se cobró.

Opciones disponibles:
too_short,
null
creditsCharged
integer
requerido

Créditos de IA cobrados por esta solicitud (0 cuando se omite).

predictionShort
enum<string>

Veredicto general de la página. Presente solo cuando la página se comprobó.

Opciones disponibles:
AI,
AI-Assisted,
Human,
Mixed
fractionAi
number

Fracción de la página detectada como generada por IA (0-1).

fractionAiAssisted
number

Fracción detectada como asistida por IA (0-1).

fractionHuman
number

Fracción detectada como escrita por humanos (0-1).

windows
object[]

Pasajes marcados (no humanos). Presente solo cuando la página se comprobó.