API docs by Redocly

さくらの AI Engine Inference API (1.0.0)

Download OpenAPI specification:Download

さくらの AI Engine チャット補完 / 音声書き起こし

Create chat completion

チャット補完のリクエストの代表例です。利用するモデルによってはサポートされていないパラメータもありますので、ご注意ください。

Authorizations:
BearerAuth
Request Body schema: application/json
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

ストリーミング応答を有効にするかどうか。

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "messages": [
    ],
  • "max_tokens": 1,
  • "temperature": 1,
  • "tool_choice": "none",
  • "tools": [
    ],
  • "stream": false
}

Create a transcription

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
file
required
string <binary>

Audio file to transcribe. Common formats: mp3, mp4, m4a, wav, webm, 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

Responses

Response samples

Content type
application/json
{
  • "model": "whisper-large-v3-turbo",
  • "text": "本日はご利用いただきありがとうございます。"
}