Ejemplos reales de la API

Prueba ejemplos sintéticos al instante o ejecuta los mismos flujos con la API real de ShinrAI.

Datos sintéticos de forma predeterminada

Ver el flujo antes de usar una clave

Cada escenario empieza con un resultado sintético grabado y no realiza solicitudes a la API. Cambia al modo en vivo para usar tu propia clave y cuota.

Proteger un mensaje de soporte

Sustituye la identidad del cliente antes de enviar el caso a un asistente externo y restaura la respuesta localmente.

Original→Protected→Restored reply

{"protected":"Nora Winter needs help with order 4815.","restored_reply":"Emma Weber can reset order 4815."}

Ejecútalo tú mismo

Requisitos previos

Configura SHINRAI_API_KEY y, si quieres, SHINRAI_API_URL. Usa solo textos de soporte sintéticos durante las pruebas.

Comando

curl "${SHINRAI_API_URL:-https://api.shinrai.innovius.io}/v1/redact"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json"   -d '{"text":"Emma Weber needs help with order 4815.","mode":"replace","include_mapping":true}'

Resultado esperado

La respuesta contiene el texto protegido, un mapa local, las entidades detectadas y el uso. Usa el mapa en tu aplicación para restaurar la respuesta del asistente.

Solución de problemas

Una respuesta de protección fallida debe detener el envío posterior. Revisa el error para detectar credenciales no válidas, cuota, tamaño de carga o procesamiento no disponible.

Guía de protección de texto · Operación de API · Secure AI Suite

Proteger registros de CRM de forma coherente

Usa un solo mapa por solicitud para que la misma persona reciba la misma sustitución en todos los registros.

{"texts":["Nora Winter owns account A-17.","Email Nora Winter at nora@example.net"],"mapping":{"Emma Weber":"Nora Winter"}}

Ejecútalo tú mismo

Requisitos previos

Configura SHINRAI_API_KEY; exporta solo filas de CRM sintéticas durante la evaluación.

Comando

curl "${SHINRAI_API_URL:-https://api.shinrai.innovius.io}/v1/redact/batch"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json"   -d '{"texts":["Emma Weber owns A-17.","Email Emma Weber at emma@example.com."],"mode":"replace","include_mapping":true}'

Resultado esperado

Ambos resultados reutilizan la misma sustitución para Emma Weber, y la respuesta devuelve un mapa de la solicitud y el uso agregado.

Solución de problemas

Envía los registros relacionados en un solo lote. Las solicitudes separadas solo conservan la coherencia si la aplicación aporta el mapa anterior.

Lotes coherentes · Operación de API · Integración de n8n

Proteger el contexto antes de una solicitud de IA

Envía al modelo el contexto recuperado y protegido, y conserva el mapa de sustitución en tu aplicación.

Retrieved context→ShinrAI→AI→Local restore

{"model_input":"Summarize Nora Winter's account.","restored_reply":"Emma Weber's account is ready for review."}

Ejecútalo tú mismo

Requisitos previos

Configura la clave de ShinrAI y MODEL_ENDPOINT, MODEL_NAME y MODEL_API_KEY para un endpoint compatible con OpenAI.

Comando

curl -O https://shinrai.innovius.io/downloads/examples/shinrai-ai-workflow-python.py
SHINRAI_API_KEY=... MODEL_ENDPOINT=https://model.example/v1   MODEL_NAME=your-model MODEL_API_KEY=... python shinrai-ai-workflow-python.py

Resultado esperado

El script muestra la entrada protegida del modelo y una respuesta restaurada localmente. El mapa de sustitución nunca entra en la solicitud al modelo.

Solución de problemas

Si la protección falla, el script termina antes de llamar al modelo. Comprueba ambos endpoints y credenciales por separado y vuelve a intentarlo con contexto sintético.

Guía de protección de texto · Operación de API · Ejemplo de Python · Ejemplo de JavaScript · Open WebUI

Proteger un documento

Sube un archivo sintético TXT, PDF o DOCX, sigue el trabajo y recupera los artefactos protegidos.

{"status":"succeeded","artifacts":{"text":"/v1/documents/jobs/demo/artifacts/text","pdf":"/v1/documents/jobs/demo/artifacts/pdf"}}

Ejecútalo tú mismo

Requisitos previos

Crea un archivo TXT, PDF o DOCX sintético y configura SHINRAI_API_KEY.

Comando

curl -i -X POST "${SHINRAI_API_URL:-https://api.shinrai.innovius.io}/v1/documents/jobs?mode=replace&include_mapping=true"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: text/plain"   --data-binary @sample.txt

Resultado esperado

Una respuesta 202 devuelve el ID del trabajo y Location. Consulta esa URL hasta que aparezca succeeded y descarga los artefactos indicados.

Solución de problemas

Respeta Retry-After durante las consultas. Un despliegue puede rechazar tipos de archivo o formatos de artefacto no compatibles; revisa el error del trabajo antes de reintentar.

Guía de documentos · Operación de API · Integración de Nextcloud

Ejecutar localmente el flujo completo de IA

Los ejemplos descargables llaman a ShinrAI, envían solo texto protegido a un endpoint de modelo compatible con OpenAI y restauran la respuesta localmente. Las credenciales del modelo y de ShinrAI proceden de variables de entorno.

Descargar Python Descargar JavaScript