Similarity and AI detection reports, by API Reportes de similitud y detección de IA, por API

01How it worksCómo funciona

Three steps, always the same. Analysis is not instant: you upload, you wait, you collect. Tres pasos, siempre los mismos. El análisis no es instantáneo: subes, esperas y recoges.

Every route hangs off https://api.similaritycheck.app/api/v1 and answers JSON. Accepted formats are .docx, .doc, .pdf and .txt, up to 50 MB. Todas las rutas cuelgan de https://api.similaritycheck.app/api/v1 y responden JSON. Los formatos admitidos son .docx, .doc, .pdf y .txt, hasta 50 MB.

02Your tokenTu token

We hand you a permanent token when your account is created. It goes in the Authorization header of every call and it does not expire: if you ever need to invalidate it, we issue a new one and the old one stops working immediately. Te entregamos un token permanente al darte de alta. Va en la cabecera Authorization de cada llamada y no caduca: si necesitas invalidarlo, te generamos otro y el anterior deja de servir en el acto.

Authorization: Bearer YOUR_TOKEN

03SandboxProbador

Paste your token and send a real document from here. This is the same API you will use in production, so it spends one credit for every document accepted. Pega tu token y envía un documento de verdad desde aquí. Es la misma API que usarás en producción, así que consume un crédito por cada documento que se acepte.

If your plan only includes one report type, asking for the other returns an error and costs no credit: you are only charged once the document enters analysis. Si tu plan solo incluye un tipo de reporte, pedir el otro devuelve un error y no gasta crédito: solo se cobra cuando el documento entra a analizarse.

04Endpoints

Five routes. The first two already give you a complete integration. Cinco rutas. Con las dos primeras ya tienes una integración completa.

curl -X POST https://api.similaritycheck.app/api/v1/documents \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: order-4471" \
  -F "file=@thesis.docx" \
  -F "reports=both"

{
  "success": true,
  "orderId": "a7f3c9d1",
  "status": "completed",
  "requested": "both",
  "result":  { "similarity": 18.4, "aiDetection": 7.2 },
  "reports": {
    "similarity":  "https://...",
    "aiDetection": "https://...",
    "expiresAt": "2026-09-07T18:30:00.000Z"
  }
}

05Similarity, AI or bothSimilitud, IA o ambos

There are two levels and they are worth keeping apart. Your plan sets which reports you have contracted. Each document can ask for less than that with the reports field, and it comes back sooner. Hay dos niveles y conviene no confundirlos. Tu plan define qué reportes tienes contratados. Cada documento puede pedir menos que eso con el campo reports, y así el informe sale antes.

The response only carries the fields of the report you asked for. If you asked for similarity alone, you will not see aiDetection set to null: it simply is not there, so you never mistake it for a failed analysis. La respuesta solo trae los campos del reporte que pediste. Si pediste únicamente similitud, no verás aiDetection en null: sencillamente no aparece, para que no lo confundas con un análisis fallido.

06States and reasonsEstados y motivos

A document goes through four states and only four. Code against these names: they will not change. Un documento pasa por cuatro estados y solo cuatro. Programa contra estos nombres: no van a cambiar.

Failure reasonsMotivos de fallo

React to the reasonCode, not to the text: the text may be rewritten, the code will not. Reacciona al reasonCode, no al texto: el texto puede reescribirse, el código no.

07Credits and limitsCréditos y límites

An accepted document spends one credit. Credits are sold in packs with their own expiry date and are consumed starting with the pack that expires soonest, so you never lose the nearest ones while spending the others. Un documento aceptado gasta un crédito. Los créditos se venden por paquetes con su propia fecha de caducidad y se consumen empezando por el que antes vence, para que no pierdas los más próximos mientras gastas los otros.

On a 429, wait the seconds given in Retry-After and try again. Check /capacity before a large batch and spread your uploads. Ante un 429, espera los segundos que indica Retry-After y reintenta. Consulta /capacity antes de una carga grande y reparte los envíos.

08Error codesCódigos de error

Every error carries success: false, a stable code and a readable error. Todos los errores traen success: false, un code estable y un error legible.