List Files · Moss API

Request parameters

QueryTypeRequiredDescription

limit: integerOptional

Number of records to return. Valid range: 1–200.

offset: integerOptional

Offset. Valid range: 0–100000.

Return value

FieldTypeDescription

object: string

Fixed as list.

data[].id: string

File id, i.e. the file_id used by subsequent endpoints.

data[].object: string

Fixed as file.

data[].bytes: integer

File size in bytes.

data[].created_at: integer

Creation time, a Unix timestamp in seconds.

data[].filename: string

Original filename.

data[].purpose: string

File-purpose label; it may be an empty string.

data[].status: string

File status, subject to the actual server response.

Next steps

Get File

Get the metadata of a single file.

Delete File

Delete an uploaded file.

Request example

curl -X GET "https://api.mosi.cn/v1/files?limit=20" \
  -H "Authorization: Bearer $MOSS_API_KEY"

import os
import requests

response = requests.get(
        "https://api.mosi.cn/v1/files?limit=20",
        headers={
        "Authorization": f"Bearer {os.environ['MOSS_API_KEY']}",
        },
)

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

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

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

Response example

{
  "object": "list",
  "data": [
    {
      "id": "<file_id>",
      "object": "file",
      "bytes": 1048576,
      "created_at": 1710000000,
      "filename": "speech.wav",
      "status": "active"
    }
  ]
}