Tool-Referenz

Die Eingaben, gültigen Werte und die Ausgabestruktur jedes eingebauten Tools — 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, und was jedes davon ausgibt. Für die genaue HTTP-Anfrage-/Antwortform jedes Aufrufpfads (anonym vs. authentifiziert) und die vollständigen Fehlertabellen siehe Direkte API-Integration.

Die Tools

Alle Tools unten sind anonym aufrufbar über POST /tools/:slug/run, das Muster aus Ihr erster SDK-Aufruf, und sind dieselben, die auf der öffentlichen Tools-Seite gezeigt werden. Sie sind auch authentifiziert aufrufbar über POST /tickets — siehe Holen Sie sich Ihren API-Schlüssel und Wählen Sie Ihren Auth-Modus.

Dies sind zwei separate HTTP-Endpunkte, nicht ein Endpunkt, der über einen Header gesteuert wird, und sie geben für dasselbe Tool unterschiedliche Namen der Ausgabefelder zurück — siehe Direkte API-Integration für die vollständige Anfrage-/Antwortform jedes einzelnen.

Jedes Tool hat sowohl einen Slug (was das öffentliche Tool-Portal und POST /tools/:slug/run verwenden) als auch eine pipeline_id (was ai.run({ pipeline: ... }) und POST /tickets verwenden). Sie sind für jedes Tool derselbe String, außer bei translate, dessen Slug translate lautet, dessen pipeline_id aber translate-string ist — verwenden Sie den richtigen für den Aufruf, den Sie tätigen.

Tool	Slug	pipeline_id	Credits
Translate	`translate`	`translate-string`	1
Summarize	`summarize`	`summarize`	1
Rewrite	`rewrite`	`rewrite`	1
Grammar fix	`grammar-fix`	`grammar-fix`	1
Email generator	`email-generator`	`email-generator`	2
Knowledge base Q&A	`knowledge-base-qa`	`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.

Keines davon passt zu dem, was Sie brauchen? Raw-Prompt-Modus lässt Sie einen benutzerdefinierten System-/User-Prompt senden statt eine dieser festen Vorlagen zu verwenden — es erfordert eine separate Freigabe für Ihre Zugangsdaten, daher sollten die meisten Integrationen hier beginnen und nur dann zu Raw mode greifen, wenn nichts unten den Anwendungsfall abdeckt.

„Gültige Werte” ist eine Empfehlung, keine serverseitige Durchsetzung — auch nicht authentifiziert. Für jedes select-/enum-artige Feld unten (target_language, language, extract, action, tone usw.) validiert der authentifizierte POST /tickets-Pfad, dass das Feld vorhanden ist (falls erforderlich) und den richtigen Typ und die richtige Größe hat — er prüft nicht, ob der Wert einer der aufgeführten Optionen entspricht. Senden Sie einen Wert außerhalb der Liste, wird er unverändert direkt an das LLM weitergereicht, sowohl auf dem anonymen als auch auf dem authentifizierten Pfad. Nur required/Typ/Länge werden durchgesetzt.

translate

Slug: translate · pipeline_id: translate-string

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 (authentifizierte /tickets-Form): translation (der übersetzte Text), applied_terms (welche Glossarbegriffe, falls vorhanden, angewendet wurden). Der anonyme Tool-Portal-Pfad normalisiert dies stattdessen zu result.text — siehe Direkte API-Integration für die vollständigen Anfrage-/Antwortformen der beiden Endpunkte.

const out = await ai.run({
  pipeline: "translate-string",   // pipeline_id, NICHT der "translate"-Slug
  inputs: { text: "Hello", target_language: "de" },
});
// out.translation === "Hallo"

summarize

Slug: summarize · pipeline_id: 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

Slug: rewrite · pipeline_id: 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

Slug: grammar-fix · pipeline_id: 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

Slug: email-generator · pipeline_id: 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

Slug: knowledge-base-qa · pipeline_id: 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, und jede hat ihre eigene vollständige Tabelle. Siehe Direkte API-Integration für die vollständigen anonymen und authentifizierten Fehlertabellen (Statuscodes, Fehlercodes und was jeder davon bedeutet), und Wählen Sie Ihren Auth-Modus dafür, wie Zugangsdaten-Freigaben im Detail funktionieren.