Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)
Copyright SAKURA internet Inc.
チャット生成のリクエストの代表例です。利用するモデルによってはサポートされていないパラメータもありますので、ご注意ください。
| model required | string 利用するチャットモデル名。利用可能なモデルはコントロールパネル等をご確認ください。 |
required | Array of Developer message (object) or System message (object) or User message (object) or Assistant message (object) or Tool message (object) チャットのメッセージ履歴。モデルによってサポートしているメッセージタイプが異なります。 |
| max_tokens | integer >= 1 応答生成に使用する最大トークン数。 |
| temperature | number [ 0 .. 2 ] Default: 1 生成の多様性を制御するパラメータ。値が高いほど多様な応答が生成され、値が低いほど決定的な応答が生成されます。 |
string or ChatCompletionNamedToolChoice (object) (ChatCompletionToolChoiceOption) | |
Array of ChatCompletionTool (object) モデルが利用可能なツールのリスト。 | |
| stream | boolean Default: false ストリーミング応答を有効にするかどうか。 |
| reasoning_effort | string Reasoning/Thinking の強度を制御するパラメータ。 受け付ける値はモデルに依存します。例: "low", "medium", "high", "none"。 "none" を指定すると推論出力が無効になります。 |
object モデルへの追加パラメータを指定するためのオブジェクト。
例えば |
{- "model": "string",
- "messages": [
- {
- "content": "string",
- "role": "developer"
}
], - "max_tokens": 1,
- "temperature": 1,
- "tool_choice": "none",
- "tools": [
- {
- "type": "function",
- "function": {
- "description": "string",
- "name": "string",
- "parameters": { }
}
}
], - "stream": false,
- "reasoning_effort": "string",
- "chat_template_kwargs": { }
}OpenAI互換のResponses APIエンドポイントです。 利用するモデルによってはサポートされていないパラメータもありますので、ご注意ください。
| model required | string 使用するモデル名 |
required | string or Array of objects モデルへの入力。文字列またはメッセージオブジェクトの配列を指定できます |
| instructions | string モデルのコンテキストに挿入されるシステムプロンプト |
| stream | boolean Default: false ストリーミング応答を有効にするかどうか |
| temperature | number [ 0 .. 1 ] 生成の多様性を制御するパラメータ。値が高いほど多様な応答が生成され、値が低いほど決定的な応答が生成されます。 |
| top_p | number [ 0 .. 1 ] Nucleus sampling の確率質量 |
| max_output_tokens | integer 生成する最大出力トークン数 |
| tools | any モデルが呼び出し可能なツールのリスト |
| tool_choice | any モデルがツールを使用する方法の制御 |
| parallel_tool_calls | boolean 並列ツール呼び出しを許可するかどうか |
| store | boolean 生成されたモデルのレスポンスを保存するかどうか（OpenAI API互換のための項目）。 ※現在は指定可能ですが、システム上は参照されません |
| previous_response_id | string チェーンする前回のレスポンスID（OpenAI API互換のための項目）。 ※現在は指定可能ですが、システム上は参照されません |
| conversation_id | string このレスポンスが属する会話のID（OpenAI API互換のための項目）。 ※現在は指定可能ですが、システム上は参照されません |
| truncation | string Enum: "auto" "disabled" モデルレスポンスの切り詰め戦略 |
| user | string エンドユーザーを表す一意な識別子 |
object Reasoning/Thinking の動作を制御するためのオプション。 effort 以外のキーもモデルに依存して受け付けます。 | |
object モデルへの追加パラメータを指定するためのオブジェクト。
例えば |
{- "model": "string",
- "input": "string",
- "instructions": "string",
- "stream": false,
- "temperature": 1,
- "top_p": 1,
- "max_output_tokens": 0,
- "tools": null,
- "tool_choice": null,
- "parallel_tool_calls": true,
- "store": true,
- "previous_response_id": "string",
- "conversation_id": "string",
- "truncation": "auto",
- "user": "string",
- "reasoning": {
- "effort": "string"
}, - "chat_template_kwargs": { }
}Anthropic互換のMessages APIエンドポイントです。 利用するモデルによってはサポートされていないパラメータもありますので、ご注意ください。
| model required | string 使用するモデル名 |
required | Array of objects non-empty 会話を構成するメッセージオブジェクトのリスト |
| max_tokens required | integer 生成する最大トークン数 |
| system | string システムプロンプト |
| stream | boolean Default: false ストリーミング応答を有効にするかどうか |
| temperature | number [ 0 .. 1 ] 生成の多様性を制御するパラメータ。値が高いほど多様な応答が生成され、値が低いほど決定的な応答が生成されます。 |
| top_p | number [ 0 .. 1 ] Nucleus sampling の確率質量 |
| top_k | integer Top-k サンプリングのパラメータ |
| stop_sequences | Array of strings 生成を停止すべきシーケンスのリスト |
Array of objects モデルが呼び出し可能なツールのリスト | |
object or object モデルがツールを使用する方法の制御 | |
object リクエストに添付するオプションのキーバリューペア | |
object モデルへの追加パラメータを指定するためのオブジェクト。
例えば |
{- "model": "string",
- "messages": [
- {
- "role": "user",
- "content": "string"
}
], - "max_tokens": 0,
- "system": "string",
- "stream": false,
- "temperature": 1,
- "top_p": 1,
- "top_k": 0,
- "stop_sequences": [
- "string"
], - "tools": [
- {
- "name": "string",
- "description": "string",
- "input_schema": { }
}
], - "tool_choice": {
- "type": "auto",
- "disable_parallel_tool_use": true
}, - "metadata": {
- "user_id": "string"
}, - "chat_template_kwargs": { }
}| file required | string <binary> Audio file to transcribe. Common formats: aac, m4a, mp3, mp4, ogg, wav etc. |
| model | string Value: "whisper-large-v3-turbo" Transcription model identifier served by vLLM. |
| language | string Default: "ja" Source language hint (BCP-47, e.g. "ja", "en-US"). |
| prompt | string Optional decoding/prompt bias (proper nouns, style hints). |
| temperature | number [ 0 .. 1 ] Default: 0 Decoding temperature. |
| stream | boolean Default: false |
{- "model": "whisper-large-v3-turbo",
- "text": "本日はご利用いただきありがとうございます。"
}埋め込みベクトル作成のリクエストの代表例です。利用するモデルによってはサポートされていないパラメータもありますので、ご注意ください。
| model required | string 利用する埋め込みモデル名。利用可能なモデルはコントロールパネル等をご確認ください。 |
required | string or Array of strings |
{- "model": "string",
- "input": "string"
}{- "model": "multilingual-e5-large",
- "data": [
- {
- "index": 0,
- "object": "embedding",
- "embedding": [ ]
}
]
}テキストから音声を生成します（TTS）。
| model required | string 音声合成モデル識別子(例：zundamon) 利用可能なmodelはコントロールパネル等をご確認ください。 |
| input required | string [ 1 .. 1000 ] characters 音声合成するテキスト（最大1000文字程度） |
| voice | string 話者/スタイル(例：normal) 利用可能なvoiceはコントロールパネル等をご確認ください。 |
| instructions | string 追加指示(例： 話し方のトーンなど)。 ※現在は指定できますが無視されます。 |
| response_format | string Default: "wav" Enum: "wav" "mp3" "ogg" "aac" "flac" 出力フォーマット。 ※現在は指定できますが常にwavを返します。 |
| stream_format | string Enum: "sse" "jsonl" ストリーム形式。 ※現在は指定できますが無視されます。 |
{- "model": "zundamon",
- "voice": "normal",
- "input": "こんにちは。",
- "instructions": "落ち着いたトーンで話して",
- "response_format": "wav",
- "stream_format": "sse"
}音声合成用のクエリ(JSON)を作成します。 典型的には、/tts/v1/audio_queryでクエリを作成し、/tts/v1/synthesisに渡して音声(wav)を生成します。 このAPIはVOICEVOX Engine APIの/audio_query仕様を参考にした互換インターフェースを提供します。 公式仕様: https://voicevox.github.io/voicevox_engine/api/
| text required | string [ 1 .. 1000 ] characters 音声合成するテキスト |
| speaker required | integer >= 0 話者/スタイルID（利用可能な値はコントロールパネル等をご確認ください） |
| enable_katakana_english | boolean Default: true カタカナ英語を有効にする。 |
| core_version | string 音声合成のバージョン指定。 ※現在は指定できますが無視されます。 |
{- "accent_phrases": [ ],
- "speedScale": 1,
- "pitchScale": 0,
- "intonationScale": 1,
- "volumeScale": 1,
- "prePhonemeLength": 0.1,
- "postPhonemeLength": 0.1,
- "outputSamplingRate": 24000,
- "outputStereo": false,
- "kana": ""
}音声合成を行います。 /tts/v1/audio_query で作成したクエリ(JSON)をリクエストボディに渡して、音声(wav)を生成します。 このAPIはVOICEVOX Engine APIの/synthesis仕様を参考にした互換インターフェースを提供します。 公式仕様: https://voicevox.github.io/voicevox_engine/api/
| speaker required | integer >= 0 話者/スタイルID（利用可能な値はコントロールパネル等をご確認ください） |
| enable_interrogative_upspeak | boolean Default: true 疑問系のテキストが与えられたら語尾を自動調整する |
| core_version | string Core Version。 ※現在は指定できますが無視されます。 |
required | Array of objects アクセント句のリスト |
| speedScale required | number 全体の話速 |
| pitchScale required | number 全体の音高 |
| intonationScale required | number 全体の抑揚 |
| volumeScale required | number 全体の音量 |
| prePhonemeLength required | number 音声の前の無音時間 |
| postPhonemeLength required | number 音声の後の無音時間 |
number or null 句読点などの無音時間。nullのときは無視される。デフォルト値はnull | |
| pauseLengthScale | number Default: 1 句読点などの無音時間（倍率）。デフォルト値は1 |
| outputSamplingRate required | integer 音声データの出力サンプリングレート |
| outputStereo required | boolean 音声データをステレオ出力するか否か |
| kana required | string 読み（かな）。 [読み取り専用] AquesTalk風記法によるテキスト。音声合成用のクエリとしては無視される |
| property name* additional property | any |
{- "accent_phrases": [ ],
- "speedScale": 1,
- "pitchScale": 0,
- "intonationScale": 1,
- "volumeScale": 1,
- "prePhonemeLength": 0.1,
- "postPhonemeLength": 0.1,
- "pauseLength": null,
- "pauseLengthScale": 1,
- "outputSamplingRate": 24000,
- "outputStereo": false,
- "kana": "string"
}