Skip to main content
POST
/
v2
/
team
/
datasets
/
{id}
/
datasources
Create data source
curl --request POST \
  --url https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: <api-key>' \
  --data '
{
  "name": "test.csv",
  "type": "FILE",
  "user_id": "tmm-dsfasdfasdfa",
  "url": "https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2"
}
'
import requests

url = "https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources"

payload = {
    "name": "test.csv",
    "type": "FILE",
    "user_id": "tmm-dsfasdfasdfa",
    "url": "https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2"
}
headers = {
    "x-pd-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-pd-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'test.csv',
    type: 'FILE',
    user_id: 'tmm-dsfasdfasdfa',
    url: 'https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2'
  })
};

fetch('https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'test.csv',
    'type' => 'FILE',
    'user_id' => 'tmm-dsfasdfasdfa',
    'url' => 'https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-pd-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources"

	payload := strings.NewReader("{\n  \"name\": \"test.csv\",\n  \"type\": \"FILE\",\n  \"user_id\": \"tmm-dsfasdfasdfa\",\n  \"url\": \"https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-pd-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources")
  .header("x-pd-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"test.csv\",\n  \"type\": \"FILE\",\n  \"user_id\": \"tmm-dsfasdfasdfa\",\n  \"url\": \"https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.ai.relyt.cn/app/api/v2/team/datasets/{id}/datasources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-pd-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"test.csv\",\n  \"type\": \"FILE\",\n  \"user_id\": \"tmm-dsfasdfasdfa\",\n  \"url\": \"https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": 0,
  "data": {
    "id": "datasource-cadsgfsdagasgadsg",
    "dataset_id": "dataset-dagasdgasgasg",
    "name": "test.csv",
    "type": "FILE",
    "status": "synching"
  }
}

Authorizations

​
x-pd-api-key
string
header
required

Headers

​
x-pd-external-trace-id
string

您本地系统中设置的 Trace ID，至多支持 128 个字符。当请求发生错误时，可以将此 ID 提供给 Relyt AI 团队，协助进行故障排查。

Path Parameters

​
id
string
required

目标数据集 ID。

如需查询您有访问权限的数据集列表，请调用 GET /v2/team/datasets 接口。

Body

application/json
​
name
string
required

数据源名称，需包含文件扩展名（例如 example.csv），至多可支持 128 个字符。如超过此限制，名称将被截断展示。

​
type
string
required

数据源的类型。设置为 FILE。

​
user_id
string
required

用户 ID，即您在组织中的唯一身份标识。

​
url
string

文件 URL，用于公网访问该文件。

url 和 file_object_key 之间必须且只能指定其一。

仅支持以下扩展名的文件：.csv、.tsv、.md、.mdx、.json、.txt、.pdf、.pptx、.docx、.xls 或 .xlsx。

​
file_object_key
string

您本地上传文件的对象存储路径。

url 和 file_object_key 之间必须且只能指定其一。

支持的文件扩展名包括：.csv、.tsv、.md、.mdx、.json、.txt、.pdf、.pptx、.docx、.xls 或 .xlsx。

如何获取文件的 file_object_key：

当使用 Upload file 接口完成文件上传后，会返回该文件的file_object_key。

Response

200 - application/json
​
code
integer
required

状态码。0 表示操作成功。其它值则表示操作失败。如需进行错误排查，请参阅 错误码。

​
data
object
required

数据源对象。