Exemples d’API concrets

Essayez immédiatement des exemples synthétiques ou exécutez les mêmes flux avec l’API ShinrAI réelle.

Synthétique par défaut

Voir le flux avant d’utiliser une clé

Chaque scénario commence par un résultat synthétique enregistré et n’effectue aucune requête API. Passez en mode réel pour utiliser votre propre clé et votre quota.

Protéger un message d’assistance

Remplacez l’identité du client avant d’envoyer le dossier à un assistant externe, puis restaurez la réponse localement.

Original→Protected→Restored reply

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

L’exécuter vous-même

Prérequis

Définissez SHINRAI_API_KEY et, si nécessaire, SHINRAI_API_URL. Utilisez uniquement des messages d’assistance synthétiques pendant les tests.

Commande

curl "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/protect"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json"   -d '{"text":"Emma Weber needs help with order 4815.","policy":{"preset":"pseudonymize"},"output":{"include":["entities","mapping"]}}'

Résultat attendu

La réponse contient le texte protégé, une table locale, les entités détectées et l’utilisation. Utilisez la table dans votre application pour restaurer la réponse de l’assistant.

Dépannage

Un échec de protection doit interrompre tout envoi ultérieur. Consultez l’enveloppe d’erreur pour les identifiants, le quota, la taille de charge ou un traitement indisponible.

Guide de l’API native v2 · Opération API · Secure AI Suite

Protéger les fiches CRM de manière cohérente

Utilisez une table propre à la requête afin qu’une même personne reçoive le même remplacement dans tous les enregistrements.

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

L’exécuter vous-même

Prérequis

Définissez SHINRAI_API_KEY ; exportez uniquement des lignes CRM synthétiques pendant l’évaluation.

Commande

curl "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/protect"   -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."],"policy":{"preset":"pseudonymize"},"output":{"include":["entities","mapping"]}}'

Résultat attendu

Les deux résultats réutilisent le même remplacement pour Emma Weber. La réponse renvoie une table propre à la requête et l’utilisation totale.

Dépannage

Envoyez les enregistrements liés dans un même lot. Des requêtes séparées ne restent cohérentes que si votre application fournit la table précédente.

Guide de l’API native v2 · Opération API · Intégration n8n

Protéger le contexte avant une requête d’IA

Envoyez au modèle le contexte de recherche protégé et conservez la table de remplacement dans votre application.

Retrieved context→ShinrAI→AI→Local restore

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

L’exécuter vous-même

Prérequis

Définissez la clé ShinrAI ainsi que MODEL_ENDPOINT, MODEL_NAME et MODEL_API_KEY pour un point de terminaison compatible OpenAI.

Commande

curl -O https://getshinrai.com/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

Résultat attendu

Le script affiche l’entrée protégée du modèle et une réponse restaurée localement. La table de remplacement n’entre jamais dans la requête au modèle.

Dépannage

Si la protection échoue, le script s’arrête avant d’appeler le modèle. Vérifiez séparément les deux points de terminaison et leurs identifiants, puis réessayez avec un contexte synthétique.

Guide de l’API native v2 · Opération API · Exemple Python · Exemple JavaScript · Open WebUI

Protéger un document

Téléversez un fichier PDF ou DOCX synthétique, suivez son job et téléchargez le PDF caviardé et le texte protégé.

{"id":"job_5e2a","kind":"document","status":"succeeded","artifacts":{"protected":"/v2/jobs/job_5e2a/artifacts/protected","text":"/v2/jobs/job_5e2a/artifacts/text","entities":"/v2/jobs/job_5e2a/artifacts/entities"}}

L’exécuter vous-même

Prérequis

Créez un fichier PDF ou DOCX synthétique et définissez SHINRAI_API_KEY.

Commande

UPLOAD=$(curl -s "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/uploads" \
  -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/pdf" \
  --data-binary @sample.pdf | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -i "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/jobs" \
  -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"kind":"document","inputs":[{"kind":"file","source":{"upload":"'$UPLOAD'"}}]}'

Résultat attendu

Une réponse 202 renvoie l’identifiant du traitement et Location. Interrogez cette URL jusqu’à succeeded, puis téléchargez les artefacts indiqués.

Dépannage

Respectez Retry-After pendant l’interrogation. Un déploiement peut refuser certains types de fichiers ou formats d’artefacts ; consultez l’erreur du traitement avant de réessayer.

Guide des documents · Opération API · Intégration Nextcloud

Exécuter le flux d’IA complet localement

Les exemples téléchargeables appellent l’API PII native v2, ne transmettent que du texte protégé à un point de terminaison de modèle compatible OpenAI et restaurent la réponse localement. Les identifiants du modèle et de ShinrAI proviennent de variables d’environnement.

Télécharger Python Télécharger JavaScript