ファイルのアップロード

使い方

シナリオ	その後の使い方
音声文字起こし	音声をアップロードした後、POST /v1/audio/transcriptionsでfile_idを渡します
マルチモーダル理解	画像または動画をアップロードした後、POST /v1/responsesのコンテンツ項目でfile_idを渡します
直接アップロード	業務エンドポイントがmultipart fileに対応している場合は、事前にファイルをアップロードせず、業務リクエスト内で直接アップロードすることもできます

リクエストパラメータ

フィールド型必須説明

file: multipart file必須

multipartのファイルフィールド。1ファイルあたり最大512 MB。ファイルはアセットへストリーミングでアップロードされ、ファイル全体がメモリに読み込まれることはありません。

purpose: string必須

ファイルの用途。

戻り値

フィールド型説明

id: string

ファイルID。後続のエンドポイントで使用するfile_idです。

object: string

固定値file。

bytes: integer

ファイルのバイト数。

created_at: integer

作成時刻。Unixタイムスタンプ（秒）。

filename: string

元のファイル名。

purpose: string

アップロード時に指定した用途。

status: string

ファイルの状態。例：processed / active。失敗時はfailedが返される場合があります。サーバーの実際の返却値に準じます。

次のステップ

ファイル一覧の取得

現在のアカウントでアップロードしたファイルの一覧を取得します。

音声文字起こし

音声文字起こしのエンドポイント。

リクエスト例

curl -X POST "https://api.mosi.cn/v1/files" \
  -H "Authorization: Bearer $MOSS_API_KEY" \
  -F "purpose=audio" \
  -F "file=@./audio.wav"

import os
import requests

with open("./audio.wav", "rb") as file:
    response = requests.post(
        "https://api.mosi.cn/v1/files",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        },
        data={
            "purpose": "audio",
        },
        files={"file": file},
    )

response.raise_for_status()
print(response.json())

import { readFile } from "node:fs/promises"

const bytes = await readFile("./audio.wav")
const form = new FormData()
form.append("purpose", "audio")
form.append("file", new Blob([bytes]), "audio.wav")

const response = await fetch("https://api.mosi.cn/v1/files", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.MOSS_API_KEY,
  },
  body: form,
})

if (!response.ok) throw new Error(`HTTP ${response.status}`)
console.log(await response.json())

レスポンス例

{
  "id": "<file_id>",
  "object": "file",
  "filename": "audio.wav",
  "purpose": "audio",
  "bytes": 5242880,
  "created_at": 1710000000,
  "status": "processed"
}