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

> 返回数据集列表。
该接口仅会返回与您的 API 密钥所在同一项目中的数据集。您可以指定搜索关键词，通过名称或描述进行数据集过滤。

# List datasets

**请求示例：**

<CodeGroup>
  ```curl cURL theme={null}
  curl --request GET \
    --url https://app.ai.relyt.cn/app/api/v2/team/datasets?user_id=tmm-dafasdfasdfasdf \
    --header 'x-pd-api-key: <api-key>'
  ```

  ```python Python theme={null}
  import requests

  url = "https://app.ai.relyt.cn/app/api/v2/team/datasets?user_id=tmm-dafasdfasdfasdf"

  headers = {"x-pd-api-key": "<api-key>"}

  response = requests.request("GET", url, headers=headers)

  print(response.text)
  ```
</CodeGroup>

**返回示例：**

```json 200 theme={null}
{
  "code": 0,
  "data": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 1,
    "records": [
      {
        "id": "dataset-dasfadsgadsgas",
        "name": "mysql",
        "description": "mysql databases"
      }
    ]
  }
}
```


## OpenAPI

````yaml get /v2/team/datasets
openapi: 3.0.1
info:
  title: Team Open API Version 2 中文版本
  description: ''
  version: 1.0.0
servers:
  - url: https://app.ai.relyt.cn/app/api
    description: 体验环境
security:
  - apikey-header-x-pd-api-key: []
tags:
  - name: Session
  - name: Dataset
  - name: Data source
  - name: File
  - name: Job
paths:
  /v2/team/datasets:
    get:
      tags:
        - Dataset
      summary: List datasets
      description: |-
        返回数据集列表。

        该接口仅会返回与您的 API 密钥所在同一项目中的数据集。

        您可以指定搜索关键词，通过名称或描述进行数据集过滤。
      parameters:
        - name: page_number
          in: query
          description: 分页返回的起始页码。如不指定，则使用默认值 `1`。
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          description: 每页返回的记录数量。如不指定，则使用默认值 `10`。
          required: false
          schema:
            type: integer
        - name: search
          in: query
          description: |-
            搜索关键词，最多支持 128 个字符。所有名称或描述中包含该关键词的数据集将被返回。

            如果省略此项，将列出项目中的所有数据集。
          required: false
          schema:
            type: string
        - name: user_id
          in: query
          description: 用户 ID，即您在组织中的唯一身份标识。
          required: true
          schema:
            type: string
        - name: x-pd-external-trace-id
          in: header
          description: >-
            您本地系统中设置的 Trace ID，至多支持 128 个字符。当请求发生错误时，可以将此 ID 提供给 Relyt AI
            团队，协助进行故障排查。
          required: false
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: >-
                      状态码。**0** 表示操作成功。其它值则表示操作失败。如需进行错误排查，请参阅
                      [错误码](/introduction/error-codes)。
                  data:
                    type: object
                    properties:
                      page_number:
                        type: integer
                        description: 当前页面的页码。
                      page_size:
                        type: integer
                        description: 每页返回的数据集数量。
                      total_items:
                        type: integer
                        description: 返回的数据集总数量。
                      records:
                        type: array
                        items:
                          $ref: '#/components/schemas/DatasetDTO'
                          description: 数据集对象。
                        description: 当前页面返回的数据集列表。
                    required:
                      - page_number
                      - page_size
                      - total_items
                      - records
                    description: 返回的数据对象。
                required:
                  - data
                  - code
              examples:
                '1':
                  summary: 成功示例
                  value:
                    code: 0
                    data:
                      page_number: 1
                      page_size: 10
                      total_items: 1
                      records:
                        - id: dataset-dasfadsgadsgas
                          name: mysql
                          description: mysql databases
          headers:
            x-pd-trace-id:
              example: ''
              required: true
              description: Relyt AI 返回的 Trace ID。当请求发生错误时，可以将此 ID 提供给 Relyt AI 团队，协助进行故障排查。
              schema:
                type: string
      deprecated: false
      security:
        - apikey-header-x-pd-api-key: []
components:
  schemas:
    DatasetDTO:
      type: object
      properties:
        id:
          type: string
          description: 数据集 ID，即该数据集在项目中的唯一标识。
        name:
          type: string
          description: 数据集名称。
        description:
          type: string
          description: 数据集描述。
      required:
        - id
        - name
        - description
  securitySchemes:
    apikey-header-x-pd-api-key:
      type: apiKey
      in: header
      name: x-pd-api-key

````