Envoyer votre première requête API
Créez une clé, choisissez un contrat d’API, envoyez une requête et comprenez la réponse.
Votre premier appel API
Connectez-vous au tableau de bord et finalisez votre panier. Votre premier achat d’API gérée crée une clé si aucune n’est active et l’envoie à l’adresse vérifiée du compte. Copiez-la depuis Clés API et conservez-la dans un gestionnaire de secrets, hors du code source.
Les clés créées dans le navigateur sont récupérables pendant 24 heures. L’e-mail est facultatif pour les clés supplémentaires. Après expiration, remplacez explicitement la clé ; l’ancienne devient invalide. Les achats hors ligne activent une installation sans créer de clé d’API gérée.
Les clés API authentifient les applications. Les connexions IA utilisent MCP pour donner à un assistant accès aux outils avec vos autorisations ; elles ne protègent pas automatiquement les autres conversations.
URL de base de production : https://api.getshinrai.com
curl https://api.getshinrai.com/v2/detect \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"Emma Weber, emma@example.com"}'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":"Emma Weber, emma@example.com"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'Les API de compatibilité limitent ce que ShinrAI peut renvoyer. Pour une qualité complète, utilisez l’API PII native 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="Emma Weber, emma@example.com", LanguageCode="en"))Les API de compatibilité limitent ce que ShinrAI peut renvoyer. Pour une qualité complète, utilisez l’API PII native 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":"Emma Weber, emma@example.com"},"inspectConfig":{"includeQuote":true}}'Les API de compatibilité limitent ce que ShinrAI peut renvoyer. Pour une qualité complète, utilisez l’API PII native v2.
Exemple de réponse (simulé)
Extrait JSON simulé pour la commande ci-dessus. Les détections, les valeurs de remplacement et votre solde peuvent différer.
{
"offset_unit": "codepoint",
"engine": {
"model": "shinrai-v1.5",
"layers_run": ["model", "pattern"],
"degraded": false
},
"results": [
{
"input_id": "1",
"status": "ok",
"entities": [
{
"id": "e1",
"type": "PERSON",
"span": {"start": 0, "end": 10},
"confidence": 0.98,
"source": "model"
},
{
"id": "e2",
"type": "EMAIL",
"span": {"start": 12, "end": 28},
"confidence": 1.0,
"source": "pattern"
}
]
}
],
"usage": {
"records": 1,
"weighted_records": 1.0,
"tier": "standard",
"charged": true,
"balance_after": 9999.0
}
}La réponse liste les entités de chaque entrée avec type, plage et confiance, le moteur exécuté et la consommation avec le solde restant. Cette courte requête Standard utilise un record. Les prédictions dépendent du modèle et de l’entrée.
Cet exemple utilise l’API PII native v2. L’édition hors ligne sert l’API native v1 jusqu’à ce que son image inclue la v2.
Utiliser votre client préféré
curl https://api.getshinrai.com/v2/detect \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"text":"Emma Weber, emma@example.com"}'import os, requests
response = requests.post(
"https://api.getshinrai.com/v2/detect",
headers={"Authorization": f"Bearer {os.environ['SHINRAI_API_KEY']}"},
json={"text": "Emma Weber, emma@example.com"},
)
response.raise_for_status()
for entity in response.json()["results"][0]["entities"]:
print(entity["type"], entity["span"], entity["confidence"])const response = await fetch("https://api.getshinrai.com/v2/detect", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SHINRAI_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ text: "Emma Weber, emma@example.com" }),
});
if (!response.ok) throw new Error(`ShinrAI HTTP ${response.status}`);
const { results } = await response.json();
for (const entity of results[0].entities) console.log(entity.type, entity.span, entity.confidence);