Erste API-Anfrage senden

Erstellen Sie einen Schlüssel, wählen Sie einen API-Vertrag, senden Sie eine Anfrage und verstehen Sie die Antwort.

Ihr erster API-Aufruf

Am Dashboard anmelden und schließen Sie Ihren Warenkorb ab. Beim ersten Kauf für die verwaltete API wird ein API-Schlüssel erstellt, sofern keiner aktiv ist, und an Ihre bestätigte Konto-Adresse gesendet. Kopieren Sie ihn unter API-Schlüssel und speichern Sie ihn sicher außerhalb des Quellcodes.

Im Browser erstellte Schlüssel können 24 Stunden lang erneut abgerufen werden. Bei zusätzlichen Schlüsseln können Sie den E-Mail-Versand abwählen. Nach Ablauf der Wiederherstellung können Sie den Schlüssel ausdrücklich ersetzen; der alte wird ungültig. Reine Offline-Käufe werden installationsgebunden aktiviert und erstellen keinen verwalteten API-Schlüssel.

API-Schlüssel authentifizieren Anwendungen. KI-Verbindungen nutzen MCP für Werkzeugzugriff mit Ihren gewählten Berechtigungen; das Verbinden eines Assistenten schützt nicht automatisch andere Chatnachrichten.

Basis-URL Produktion: 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"}}'

Kompatibilitäts-APIs begrenzen, was ShinrAI zurückgeben kann. Für volle Qualität verwenden Sie die native PII-API 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"))

Kompatibilitäts-APIs begrenzen, was ShinrAI zurückgeben kann. Für volle Qualität verwenden Sie die native PII-API 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}}'

Kompatibilitäts-APIs begrenzen, was ShinrAI zurückgeben kann. Für volle Qualität verwenden Sie die native PII-API v2.

Beispielausgabe (simuliert)

Simulierter JSON-Auszug zum obigen Befehl. Erkennungen, Ersatzwerte und Ihr Guthaben können abweichen.

{
  "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
  }
}

Die Antwort nennt die Entitäten jeder Eingabe mit Typ, Bereich und Konfidenz, die ausgeführte Engine sowie die Nutzung mit dem verbleibenden Guthaben. Diese kurze Standard-Anfrage verbraucht einen Record. Die erkannten Entitäten hängen vom Modell und von der Eingabe ab.

Dieses Beispiel verwendet die native PII-API v2. Die Offline-Edition bedient die native API v1, bis ihr Image v2 enthält.

Leitfaden zur nativen API v2 →

Bevorzugten Client verwenden

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);