Desarrolla con ShinrAI
Protege los datos personales sin perder el contexto útil.
Empieza con una solicitud real, sigue una receta de producción o revisa cada endpoint de cliente compatible.
Elija su API
Un solo servicio y los mismos modelos atienden cada contrato. Elija el contrato que encaje con su código.
Un solo contrato para la API alojada y una instalación en su propio clúster. La edición sin conexión ofrece la API nativa v1 hasta que su imagen incluya la v2.
- Contrato estable 2.0.0: los cambios dentro de 2.x solo añaden elementos
- Texto, tablas, JSON y transcripciones
- Imágenes: OCR, recuadros en píxeles por entidad y la imagen censurada como respuesta
- Audio: reconocimiento de voz, intervalos de tiempo y la grabación con cada dato personal cubierto con un pitido
- Documentos PDF y DOCX mediante trabajos, con el PDF censurado de vuelta
- Grabaciones largas mediante trabajos
- Niveles en tiempo real, estándar y por lotes
- Las sesiones mantienen un mapa de reemplazos entre solicitudes
- Los cuerpos de texto e imagen sin envoltorio funcionan directamente con curl
Mantenga su SDK y su formato de solicitud. Cada API de proveedor tiene su propio endpoint: cambie solo el endpoint y use su clave de ShinrAI.
| API | Endpoint: cambie solo este | Alternativa en el host de la API |
|---|---|---|
| Azure AI Language PII | https://azure.api.getshinrai.com | https://api.getshinrai.com/v1/azure |
| Google Cloud DLP | https://google.api.getshinrai.com | https://api.getshinrai.com/v1/google |
| AWS Comprehend | https://aws.api.getshinrai.com | https://api.getshinrai.com/v1/aws |
- Los clientes de Azure envían la clave de ShinrAI como clave de suscripción.
- Los clientes de Google la envían como clave de API o como token Bearer.
- Los clientes de AWS firman con credenciales SigV4 que usted crea con la clave de ShinrAI.
Cada endpoint de proveedor publica su propio documento OpenAPI en /openapi.json. El entorno de pruebas usa los mismos nombres con api-sbx.
El contrato del proveedor limita lo que ShinrAI puede devolver: tipos, confianza, medios, sesiones y trabajos. Por eso, los resultados pueden ser más débiles de lo que ShinrAI puede ofrecer. Para obtener la calidad completa, use la API PII nativa v2.
Las integraciones v1 existentes siguen funcionando; los proyectos nuevos usan la API nativa v2.
Cada contrato se publica como OpenAPI 3.1. No necesita ningún SDK: cualquier cliente HTTP funciona.
La API nativa v2 en 60 segundos
Defina su clave una vez. Cada ejemplo la envía como token Bearer.
export SHINRAI_API_KEY=shr_live_...
Encontrar datos personales en un texto
curl -s https://api.getshinrai.com/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" -d '{"text": "Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}'curl 'https://azure.api.getshinrai.com/language/:analyze-text?api-version=2023-04-01' \
-H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
# Once: create SigV4 credentials with your ShinrAI key
# curl -X POST https://aws.api.getshinrai.com/providers/aws/credentials -H "Authorization: Bearer $SHINRAI_API_KEY"
import boto3, os
client = boto3.client(
"comprehend",
region_name="eu-central-1",
endpoint_url="https://aws.api.getshinrai.com",
aws_access_key_id=os.environ["SHINRAI_AWS_ACCESS_KEY_ID"],
aws_secret_access_key=os.environ["SHINRAI_AWS_SECRET_ACCESS_KEY"],
)
print(client.detect_pii_entities(Text="Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00", LanguageCode="en"))Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
curl 'https://google.api.getshinrai.com/v2/projects/my-project/locations/global/content:inspect' \
-H "x-goog-api-key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"item":{"value":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"},"inspectConfig":{"includeQuote":true}}'Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
Enviar un archivo de texto tal cual y recibir el texto protegido
curl -s "https://api.getshinrai.com/v2/protect?preset=label" -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: text/plain" -H "Accept: text/plain" --data-binary @letter.txt# Azure returns the masked text as redactedText.
curl 'https://azure.api.getshinrai.com/language/:analyze-text?api-version=2023-04-01' \
-H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
curl 'https://google.api.getshinrai.com/v2/projects/my-project/locations/global/content:deidentify' \
-H "x-goog-api-key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"item":{"value":"Anna Weber, anna.weber@example.org"},"deidentifyConfig":{"infoTypeTransformations":{"transformations":[{"primitiveTransformation":{"replaceWithInfoTypeConfig":{}}}]}}}'Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
Recibir la captura de pantalla censurada
curl -s https://api.getshinrai.com/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: image/png" -H "Accept: image/png" --data-binary @screenshot.png -o redacted.png
Iniciar un trabajo para un lote grande
Primero suba un archivo JSONL con una entrada por línea. La respuesta de la subida contiene el ID para el trabajo.
curl -s https://api.getshinrai.com/v2/jobs \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: rows-2026-09-28" \
-d '{"kind": "text_batch",
"inputs": [{"kind": "file", "source": {"upload": "up_..."}}],
"output": {"artifacts": ["protected", "entities"]}}'
Guía de la API nativa v2 · Referencia completa de v2 (Markdown) · Explorador de API (Swagger) · OpenAPI 3.1 para v2 · OpenAPI 3.1 para todas las API
Elige por dónde empezar
Ejecutar Hello ShinrAI localmente
Pruebe y depure todo el flujo de protección en un espacio de trabajo del navegador. Use una clave de ShinrAI para texto, archivos, escaneos y API compatibles; añada una clave de LLM solo para el chat protegido.
Instale uv una vez y ejecute la versión verificada:
uvx --from https://github.com/Innovius-ai/hello-shinrai/releases/download/v0.1.4/hello_shinrai-0.1.4-py3-none-any.whl hello-shinrai
Use los espacios Texto, Archivos, Chat, Comparación con Azure y Explorador de API. Las claves permanecen en el proceso local salvo que decida guardarlas expresamente en el almacén de credenciales del sistema operativo.
Versión verificada: v0.1.4. Para actualizar, cambie ambos valores de versión en la URL del wheel.
Referencia de la API
Ejecuta solicitudes en la API real
El explorador lo sirve la pasarela ShinrAI y se genera a partir de sus rutas de cliente registradas. Sus scripts y estilos se alojan con el backend.