Envía tu primera solicitud a la API
Crea una clave, elige un contrato de API, envía una solicitud y comprende la respuesta.
Tu primera llamada API
Inicia sesión en el panel y complete su carrito. Su primera compra de API gestionada crea una clave si no hay ninguna activa y la envía al correo verificado de su cuenta. Cópiela desde Claves API y guárdela en un gestor de secretos, fuera del código fuente.
Las claves creadas en el navegador se pueden recuperar durante 24 horas. Puede desactivar el correo para claves adicionales. Si vence el plazo, reemplace expresamente la clave; la anterior dejará de funcionar. Las compras solo sin conexión activan una instalación y no crean una clave de API gestionada.
Las claves API autentican aplicaciones. Las conexiones de IA usan MCP para dar al asistente acceso a herramientas con sus permisos; conectar un asistente no protege automáticamente otros mensajes de chat.
URL base de producción: 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"}}'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="Emma Weber, emma@example.com", 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":"Emma Weber, emma@example.com"},"inspectConfig":{"includeQuote":true}}'Las API de compatibilidad limitan lo que ShinrAI puede devolver. Para obtener la calidad completa, use la API PII nativa v2.
Ejemplo de respuesta (simulado)
Extracto JSON simulado para el comando anterior. Las detecciones, los valores de sustitución y tu saldo pueden variar.
{
"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 respuesta enumera las entidades de cada entrada con tipo, rango y confianza, el motor que se ejecutó y el uso con el saldo restante. Esta solicitud Standard corta usa un registro. Las predicciones dependen del modelo y de la entrada.
Este ejemplo usa la API PII nativa v2. La edición sin conexión ofrece la API nativa v1 hasta que su imagen incluya la v2.
Usar tu cliente preferido
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);