> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ariacompute.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 列出文档 - GET /v1/workspaces/:workspace_id/documents

> 通过 GET /v1/workspaces/:workspace_id/documents 返回工作空间下的文档，可按 kb_id 过滤。最小角色 viewer。

返回工作空间下的文档，可通过 `kb_id` 查询参数限定某个知识库。

## 接口

```http theme={null}
GET /v1/workspaces/:workspace_id/documents
```

## 认证

`Authorization: Bearer <jwt>` 或 `X-API-Key <sk_...>`。最小角色：**viewer**。

## 路径参数

<ParamField path="workspace_id" type="string" required>
  工作空间 id。
</ParamField>

## 查询参数

<ParamField query="kb_id" type="string">
  仅返回该知识库下的文档。
</ParamField>

## 响应

响应为一个数组，每个元素为文档：

<ResponseField name="id" type="string">
  文档 id。
</ResponseField>

<ResponseField name="kb_id" type="string">
  所属知识库 id。
</ResponseField>

<ResponseField name="workspace_id" type="string">
  所属工作空间 id。
</ResponseField>

<ResponseField name="name" type="string">
  文件名。
</ResponseField>

<ResponseField name="path" type="string">
  存储路径。
</ResponseField>

<ResponseField name="mime" type="string">
  MIME 类型。
</ResponseField>

<ResponseField name="status" type="string">
  解析状态（`parsing` / `parsed` / `failed`）。
</ResponseField>

<ResponseField name="created_at" type="string">
  上传时间（RFC3339）。
</ResponseField>

## 示例

<RequestExample>
  ```bash cURL theme={null}
  curl "https://memo.ariacompute.cn/v1/workspaces/ws_01a2b3c4d5e6/documents?kb_id=kb_01a2b3c4d5e6" \
    -H "Authorization: Bearer <jwt>"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "doc_01a2b3c4d5e6",
      "kb_id": "kb_01a2b3c4d5e6",
      "workspace_id": "ws_01a2b3c4d5e6",
      "name": "product.pdf",
      "path": "kb_01a2b3c4d5e6/product.pdf",
      "mime": "application/pdf",
      "status": "parsed",
      "created_at": "2026-10-12T08:02:00Z"
    }
  ]
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.