> ## 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.

> 上传本地文件。

# Upload local file

支持的文件格式包括：**.csv**、**.tsv**、**.md**、**.mdx**、**.json**、**.txt**、**.pdf**、**.pptx**、**.ppt**、**.doc**、**.docx**、**.xls** 或 **.xlsx**。

您可以使用此接口上传本地文件，然后使用获得的 `file_object_key` 来创建数据源。

**请求示例：**

<CodeGroup>
  ```curl cURL theme={null}
  curl --location 'https://app.ai.relyt.cn/app/api/v2/team/file/upload-datasource' \
  --header 'x-pd-api-key: <api-key>' \
  --header 'x-pd-external-trace-id;' \
  --header 'Cookie: Cookie_1=value; metabase.DEVICE=f3cb3dbb-ef62-4026-845e-1480431c751d' \
  --form 'file=@"/Users/username/Downloads/c5168946-8f1a-4c92-a167-5e3be57745be.csv"' \
  --form 'user_id="tmm-cm5ao3yoe00zm01l1u1e7p3pj"'
  ```

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

  url = "https://app.ai.relyt.cn/app/api/v2/team/file/upload-datasource"

  payload = {'user_id': 'tmm-cm5ao3yoe00zm01l1u1e7p3pj'}
  files=[
    ('file',('c5168946-8f1a-4c92-a167-5e3be57745be.csv',open('/Users/jiaoqi/Downloads/c5168946-8f1a-4c92-a167-5e3be57745be.csv','rb'),'text/csv'))
  ]
  headers = {
    'x-pd-api-key': '<api-key>',
    'x-pd-external-trace-id': '',
  }

  response = requests.request("POST", url, headers=headers, data=payload, files=files)

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

**返回示例：**

```json 200 theme={null}
{
  "code": 0,
  "data": {
    "file_object_key": "/tmp/sdgsagdsgsadgasdg.csv"
  }
}
```


## OpenAPI

````yaml post /v2/team/file/upload-datasource
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/file/upload-datasource:
    post:
      tags:
        - File
      summary: Upload local file
      description: >-
        上传本地文件。支持的文件格式包括：**.csv**、**.tsv**、**.md**、**.mdx**、**.json**、**.txt**、**.pdf**、**.pptx**、**.docx**、**.xls**
        或 **.xlsx**。


        您可以使用此接口上传本地文件，然后使用获得的 `file_object_key` 来创建数据源。详细操作指南，请参考
        [如何上传本地文件](/developer-guides/upload-file)。
      parameters:
        - name: x-pd-external-trace-id
          in: header
          description: >-
            您本地系统中设置的 Trace ID，至多支持 128 个字符。当请求发生错误时，可以将此 ID 提供给 Relyt AI
            团队，协助进行故障排查。
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  format: binary
                  type: string
                  description: >-
                    要上传的文件。该字段必填，且应当包含文件数据。例如，`--form
                    'file=@"/Users/jiaoqi/Downloads/0f9a7ebd-7a2a-454a-8cd9-96accffa3107.csv"'`。
                  example: ''
                user_id:
                  description: 用户 ID，即您在组织中的唯一身份标识。
                  example: ''
                  type: string
              required:
                - file
                - user_id
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: >-
                      状态码。**0** 表示操作成功。其它值则表示操作失败。如需进行错误排查，请参阅
                      [错误码](/introduction/error-codes)。
                  data:
                    type: object
                    properties:
                      file_object_key:
                        type: string
                        description: 文件的对象存储路径。
                    required:
                      - file_object_key
                    description: 返回的数据对象。
                required:
                  - data
                  - code
              examples:
                '1':
                  summary: 'Success example:'
                  description: ''
                  value:
                    code: 0
                    data:
                      file_object_key: /tmp/sdgsagdsgsadgasdg.csv
          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:
  securitySchemes:
    apikey-header-x-pd-api-key:
      type: apiKey
      in: header
      name: x-pd-api-key

````