Upload File · Moss API

Usage

Scenario	How to use the file
Audio transcription	Upload audio, then pass its file_id to POST /v1/audio/transcriptions
Multimodal understanding	Upload an image or video, then pass its file_id in a content item for POST /v1/responses
Direct upload	If a business endpoint accepts a multipart file, you can upload it directly without creating it in advance

Request parameters

FieldTypeRequiredDescription

file: multipart fileRequired

The multipart file field. The maximum file size is 512 MB; the file is streamed into assets without reading the whole file into memory.

purpose: stringRequired

File purpose.

Return value

FieldTypeDescription

id: string

The file id, i.e. the file_id used by subsequent endpoints.

object: string

Always file.

bytes: integer

File size in bytes.

created_at: integer

Creation time, a Unix timestamp in seconds.

filename: string

The original file name.

purpose: string

The purpose marker passed in on upload.

status: string

File status, for example processed / active; failed may be returned on failure, subject to the actual server response.

Next steps

List Files

List the files uploaded under your account.

Create Transcription

Audio transcription endpoint.

Request example

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())

Response example

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