Tool-Referenz
Die Eingaben, gültigen Werte, die Ausgabestruktur und die Fehler jedes eingebauten Tools für jeden Aufrufpfad — die vollständige Referenz hinter den Schnellstart-Anleitungen.
Die vorherigen Anleitungen bringen Sie schnell zu einem funktionierenden Aufruf. Diese Seite ist die Referenz, zu der Sie zurückkehren, sobald Sie wirklich integrieren: die Eingaben und gültigen Werte jedes Tools, was jedes davon ausgibt, und genau welche Fehler zurückkommen können — aufgeteilt danach, ob Sie anonym oder mit einem Schlüssel aufrufen, denn diese beiden Pfade verhalten sich unterschiedlich.
Die Tools
Alle Tools unten sind anonym aufrufbar (kein API-Schlüssel, ratenbegrenzt) über das Muster aus Ihr erster SDK-Aufruf, und sind dieselben, die auf der öffentlichen Tools-Seite gezeigt werden. Sie sind auch authentifiziert aufrufbar (API-Schlüssel/JWT) — siehe Holen Sie sich Ihren API-Schlüssel und Wählen Sie Ihren Auth-Modus.
Tool (pipeline) | Credits |
|---|---|
translate | 1 |
summarize | 1 |
rewrite | 1 |
grammar-fix | 1 |
email-generator | 2 |
knowledge-base-qa | 2 |
Credits sind das, was ein Lauf tatsächlich gegen Ihren Plan/Ihr Wallet kostet — prüfen Sie die Zahl, bevor Sie ein Feature um ein Tool herum bauen.
translate
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
text | string | ja | bis zu 5000 Zeichen | Der Ausgangstext. Die Sprache wird automatisch erkannt — Sie geben keine Quellsprache an. |
target_language | string | ja | en, es, de, ja, fr, pt, zh-Hans, zh-Hant, ko, ar, vi, th, ms | Der Sprachcode, in den übersetzt werden soll. |
glossary_inline | string | nein | bis zu 4000 Zeichen | Optionale Begriffs-Überschreibungen, ein Paar pro Zeile als source=target oder source,target. Wird nicht gespeichert — gilt nur für diesen Aufruf. |
Ausgabe: translation (der übersetzte Text), applied_terms (welche Glossarbegriffe, falls vorhanden, angewendet wurden).
const out = await ai.run({
pipeline: "translate-string",
inputs: { text: "Hello", target_language: "de" },
});
// out.translation === "Hallo"
summarize
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
text | string | ja | bis zu 5000 Zeichen | Der zusammenzufassende Ausgangstext. |
length | string | nein | short, medium, long | Weglassen für die Standardlänge. |
language | string | nein | "" (Original beibehalten) oder ein beliebiger Code aus der translate-Tabelle oben | Ausgabesprache. Ein leerer String behält die Sprache des Quelltexts bei. |
extract | string[] | nein | action_items, decisions, risks, timeline | Null oder mehr zusätzliche strukturierte Abschnitte. Senden Sie sie in genau dieser Reihenfolge — eine andere Reihenfolge zählt für Caching-Zwecke als eine andere Anfrage, selbst wenn die Werte ansonsten identisch sind. |
Ausgabe: tldr, key_points, sowie je nachdem, welche von action_items / decisions / risks / timeline Sie in extract angefordert haben.
rewrite
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
text | string | ja | bis zu 5000 Zeichen | Der umzuschreibende Ausgangstext. |
action | string | nein | rephrase, shorten, expand, simplify, formalize, bulletize | Die Umschreib-Operation. |
tone | string | nein | professional, casual, friendly, concise | Der Zielton. |
language | string | nein | "" (Original beibehalten) oder ein beliebiger Code aus der translate-Tabelle oben | Ausgabesprache. |
glossary_inline | string | nein | bis zu 4000 Zeichen | Gleiches Format wie glossary_inline bei translate oben. |
Ausgabe: rewrite (der umgeschriebene Text), applied_terms.
grammar-fix
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
text | string | ja | bis zu 5000 Zeichen | Der zu korrigierende Ausgangstext. |
glossary_inline | string | nein | bis zu 4000 Zeichen | Gleiches Format wie glossary_inline bei translate oben. |
Ausgabe: corrected (der korrigierte Text), changes (eine Liste der Änderungen), applied_terms.
email-generator
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
purpose | string | ja | bis zu 2000 Zeichen | Worum es in der E-Mail geht und was sie abdecken soll. |
recipient | string | nein | bis zu 500 Zeichen | An wen sie adressiert ist. Weglassen für einen generischen Empfänger. |
tone | string | nein | formal, friendly, persuasive | Der Ton der verfassten E-Mail. |
glossary_inline | string | nein | bis zu 4000 Zeichen | Gleiches Format wie glossary_inline bei translate oben. |
Ausgabe: subject, body, applied_terms.
knowledge-base-qa
| Eingabe | Typ | Erforderlich | Gültige Werte | Hinweise |
|---|---|---|---|---|
question | string | ja | bis zu 1000 Zeichen | Die zu beantwortende Frage. |
context | string | ja | bis zu 6000 Zeichen | Das einzelne Dokument, auf dem die Antwort beruhen muss. |
Ausgabe: answer, grounded (ob die Antwort tatsächlich durch context gestützt wird), citation (woher in context die Antwort stammt).
Hinter diesem Tool steht kein Suchindex und kein externes Wissen — es beantwortet ausschließlich aus
dem context-Text derselben Anfrage. Für alles über einem einzelnen Dokument von ca. 6000 Zeichen
teilen Sie Ihren Quelltext auf und rufen Sie das Tool pro Abschnitt auf.
Fehler
Welche Fehler zurückkommen können, hängt davon ab, wie Sie aufrufen — anonyme und authentifizierte Aufrufe werden unterschiedlich validiert. Gehen Sie nicht davon aus, dass das Fehlerverhalten des einen Pfads auch für den anderen gilt.
Anonymer Aufruf (kein API-Schlüssel)
Das Muster aus Ihr erster SDK-Aufruf — alle oben aufgeführten Tools, ratenbegrenzt pro IP.
| Status | Fehlercode | Bedeutung |
|---|---|---|
| 404 | — | Unbekannter Tool-Slug. |
| 403 | — | Bot-Check fehlgeschlagen. |
| 429 | guest_quota_exceeded | Sie haben das anonyme Tages-Anfragelimit pro IP oder global erreicht. |
| 429 | guest_cost_exceeded | Sie haben das anonyme Tages-Kostenlimit pro IP oder global erreicht (teure Tools verbrauchen dieses Budget schneller). |
| 202 | — | Erfolg — { ticket_id, status: "QUEUED" }. Pollen Sie das Ergebnis wie bei jedem anderen Aufruf. |
Wichtig: Auf diesem Pfad werden Ihre inputs vor der Annahme des Aufrufs nicht gegen die obigen
Tabellen geprüft — ein fehlendes Pflichtfeld oder ein ungültiger Wert führt nicht zu einem 400. Stattdessen
schlägt der Lauf selbst fehl, was Sie beim Pollen des Ergebnisses sehen. Sobald Sie einen API-Schlüssel
haben, wechseln Sie zum authentifizierten Pfad unten, der im Voraus validiert.
Aufruf mit API-Schlüssel oder Session-Token
Das Muster aus Wählen Sie Ihren Auth-Modus — jedes Tool, auf das Sie Zugriff haben.
| Status | Fehlercode | Bedeutung |
|---|---|---|
| 401 | — | Fehlende, ungültige oder abgelaufene Zugangsdaten. |
| 403 | app_disabled | Ihre Anwendung wurde deaktiviert. |
| 403 | org_suspended | Ihre Organisation wurde gesperrt. |
| 403 | org_pending_deletion | Ihre Organisation ist zur Löschung vorgesehen. |
| 403 | — | Dieses Tool steht nicht auf der erlaubten Pipeline-Liste Ihrer Zugangsdaten. |
| 400 | — | Ihre inputs erfüllen die Anforderungen des Tools nicht (fehlendes Pflichtfeld, ungültiger Wert, oder die Gesamteingabe ist zu groß). Dieser Pfad validiert im Voraus, anders als der anonyme. |
| 429 | rate_limited | Sie senden Anfragen schneller als Ihr Limit pro Minute erlaubt. |
| 429 | quota_exceeded | Sie haben Ihr monatliches Anfragekontingent erreicht. |
| 429 | daily_cost_exceeded | Sie haben ein tägliches Kostenlimit erreicht — ein Geschwindigkeitslimit, zu unterscheiden vom Aufbrauchen des Guthabens unten. |
| 402 | insufficient_credits | Das Credit-Guthaben Ihrer Organisation reicht für diesen Aufruf nicht aus. Aufladen und erneut versuchen. |
| 202 | — | Erfolg — { ticket_id, status: "QUEUED" }. Pollen Sie das Ergebnis. |
Wie Zugangsdaten und die 401/403/429-Auth-Entscheidungen im Detail funktionieren, zeigt Wählen Sie Ihren Auth-Modus.