Skip to main content

List Files

Lists files in the workspace with pagination, sorted by created_at in descending order. Use scope_id to list only files within a specific session sandbox.

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

GET /files

Query parameters

ParameterRequiredTypeDefaultDescription
limitNoint20Number of items per page, maximum 100
pageNostring—Omit on the first call; pass next_page from the previous response for subsequent calls
scope_idNostring—Pass a session ID to list only files within that session sandbox

Request example

curl "$AGENTSTUDIO_URL/files?limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "data": [
    {
      "id": "file_xxx",
      "type": "file",
      "filename": "sales_2025.csv",
      "downloadable": false,
      "mime_type": "text/csv",
      "size_bytes": 524288,
      "status": "available",
      "created_at": "2026-06-16T14:51:39+08:00"
    },
    {
      "id": "file_xxx",
      "type": "file",
      "filename": "demo.png",
      "downloadable": false,
      "mime_type": "image/png",
      "size_bytes": 102400,
      "status": "checking",
      "created_at": "2026-06-16T14:48:02+08:00"
    }
  ],
  "next_page": "xxx",
  "requestId": "xxx"
}
The response contains data (an array of File objects) and next_page. File object fields are as follows:

File object fields

FieldTypeDescription
idstringFile ID, format: file_<24 alphanumeric>
typestringFixed value file
filenamestringFilename
mime_typestringMIME type detected by the server
size_bytesintFile size in bytes
downloadableboolWhether the file supports download; both direct uploads and session sandbox copies are false
statusstringSecurity review status: available / checking / rejected / type_rejected
created_atstringUpload time, ISO 8601
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration