ツールリファレンス
すべての組み込みツールの入力、有効な値、出力の形 — クイックスタートガイドの背後にある完全なリファレンスです。
これまでのガイドは、素早く動く呼び出しにたどり着くためのものでした。このページは、実際に統合を 進める段階になったときに立ち返るリファレンスです — すべてのツールの入力と有効な値、そして それぞれが何を出力するかです。各呼び出し経路（匿名 vs. 認証済み）の正確な HTTP リクエスト/ レスポンスの形と完全なエラーテーブルについては、Direct API integration を参照してください。
ツール一覧
以下のツールはすべて POST /tools/:slug/run 経由で匿名で呼び出せます — はじめての SDK
呼び出し のパターンで、公開 Tools ページに表示されるものと
同じです。認証済み（POST /tickets 経由）でも呼び出せます — API
キーを取得する と 認証モードを選ぶ
を参照してください。
この 2 つはヘッダーで切り替わる 1 つのエンドポイントではなく、別々の HTTP エンドポイントであり、 同じツールに対しても異なる出力フィールド名を返します — それぞれの完全なリクエスト/レスポンスの 形については Direct API integration を参照してください。
すべてのツールは、スラッグ（公開 Tool Portal と POST /tools/:slug/run が使う）と
pipeline_id（ai.run({ pipeline: ... }) と POST /tickets が使う）の両方を持っています。
translate を除くすべてのツールでこの 2 つは同じ文字列です — translate だけはスラッグが
translate である一方、pipeline_id は translate-string です。どちらを使うかは、行っている
呼び出しに応じて正しい方を選んでください。
| 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 は、1 回の実行があなたのプラン/wallet に対して実際に課す費用です — 機能を組み立てる前に この数字を確認してください。
これらのどれもニーズに合いませんか？ Raw prompt mode を使うと、 これらの固定テンプレートの代わりにカスタムの system/user プロンプトを送信できます — 資格情報に別途の付与が必要なため、ほとんどの統合はまずこちらから始め、以下のどれもケースを カバーしない場合にのみ raw mode に手を伸ばすべきです。
「Valid values」はガイダンスであり、サーバー側での強制ではありません — 認証済みでも同様です。 以下の
select/enum 型のフィールド（target_language、language、extract、action、toneなど）について、認証済みのPOST /tickets経路は、そのフィールドが（必須の場合） 存在すること、正しい型とサイズであることを検証しますが、値が挙げられている 選択肢のいずれかであるかは検証しません。一覧にない値を送っても、匿名経路・認証済み経路の どちらでも、そのまま変更されずに LLM に渡されます。強制されるのはrequired/型/長さのみです。
translate
- slug:
translate· pipeline_id:translate-string
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
text | string | yes | up to 5000 characters | 元となるテキストです。言語は自動検出されるため、source language を指定する必要はありません。 |
target_language | string | yes | en, es, de, ja, fr, pt, zh-Hans, zh-Hant, ko, ar, vi, th, ms | 翻訳先の言語コードです。 |
glossary_inline | string | no | up to 4000 characters | 任意の用語の上書きです。1 行に 1 ペアを source=target または source,target の形式で指定します。保存されず、この呼び出しのみに適用されます。 |
Output（認証済み /tickets の形）: translation（翻訳されたテキスト）、applied_terms
（適用された glossary 用語があればそれ）。匿名の Tool Portal 経路では、これは代わりに
result.text に正規化されます — 2 つのエンドポイントの完全なリクエスト/レスポンスの形については
Direct API integration を参照してください。
const out = await ai.run({
pipeline: "translate-string", // pipeline_id であり、"translate" スラッグではない
inputs: { text: "Hello", target_language: "de" },
});
// out.translation === "Hallo"
summarize
- slug:
summarize· pipeline_id:summarize
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
text | string | yes | up to 5000 characters | 要約対象の元となるテキストです。 |
length | string | no | short, medium, long | 省略するとデフォルトの長さになります。 |
language | string | no | "" (keep original) or any code from the translate table above | 出力言語です。空文字列にすると元のテキストの言語のまま保たれます。 |
extract | string[] | no | action_items, decisions, risks, timeline | 追加の構造化セクションを 0 個以上指定します。必ずこの順序で送信してください — キャッシュの判定上、値が同じでも順序が異なると別のリクエストとして扱われます。 |
Output: tldr、key_points、そして extract で指定した action_items / decisions / risks / timeline のうち該当するもの。
rewrite
- slug:
rewrite· pipeline_id:rewrite
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
text | string | yes | up to 5000 characters | 書き換え対象の元となるテキストです。 |
action | string | no | rephrase, shorten, expand, simplify, formalize, bulletize | 書き換えの操作内容です。 |
tone | string | no | professional, casual, friendly, concise | 目標とするトーンです。 |
language | string | no | "" (keep original) or any code from the translate table above | 出力言語です。 |
glossary_inline | string | no | up to 4000 characters | translate の glossary_inline と同じ形式です（上記参照）。 |
Output: rewrite（書き換えられたテキスト）、applied_terms。
grammar-fix
- slug:
grammar-fix· pipeline_id:grammar-fix
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
text | string | yes | up to 5000 characters | 添削対象の元となるテキストです。 |
glossary_inline | string | no | up to 4000 characters | translate の glossary_inline と同じ形式です（上記参照）。 |
Output: corrected（添削後のテキスト）、changes（変更点のリスト）、applied_terms。
email-generator
- slug:
email-generator· pipeline_id:email-generator
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
purpose | string | yes | up to 2000 characters | メールの目的と、内容に含めるべきことです。 |
recipient | string | no | up to 500 characters | 宛先です。省略すると一般的な宛先になります。 |
tone | string | no | formal, friendly, persuasive | 作成されるメールのトーンです。 |
glossary_inline | string | no | up to 4000 characters | translate の glossary_inline と同じ形式です（上記参照）。 |
Output: subject、body、applied_terms。
knowledge-base-qa
- slug:
knowledge-base-qa· pipeline_id:knowledge-base-qa
| Input | Type | Required | Valid values | Notes |
|---|---|---|---|---|
question | string | yes | up to 1000 characters | 回答してほしい質問です。 |
context | string | yes | up to 6000 characters | 回答の根拠としなければならない、単一のドキュメントです。 |
Output: answer、grounded（回答が実際に context によって裏付けられているかどうか）、citation（回答の根拠が context のどこにあるか）。
このツールの背後には検索インデックスや外部知識はありません — 同じリクエスト内の context
テキストのみをもとに回答します。約 6000 文字を超える単一ドキュメントを扱いたい場合は、元のテキストを
チャンクに分割し、チャンクごとに呼び出してください。
エラー
どのエラーが返ってくるかはどう呼び出しているか によって決まります — 匿名呼び出しと認証済み 呼び出しでは検証方法が異なり、それぞれに完全なテーブルがあります。匿名・認証済み両方の完全な エラーテーブル（ステータスコード、エラーコード、それぞれの意味）については Direct API integration を、資格情報の付与がどのように機能する かの詳細については 認証モードを選ぶ を参照してください。