Get references
Question
Question Message
API Reference
Datasets
- GETGet datasets
- POSTCreate dataset
- GETGet dataset
- PUTUpdate dataset
- DELDelete dataset
- GETGet dataset files counts
- GETGet dataset files
- PUTUpdate dataset file
- POSTAdd file to dataset
- DELDelete dataset file
- PUTRefresh dataset file list
- PUTRefresh dataset upload file list
- PUTRefresh dataset upload file list
- POSTAdd link to dataset
- POSTUpdate Dataset Configs
- POSTBind dataset to ai
- DELUnbind dataset to ai
- GETGet ai datasets
- POSTAdd Lark files to dataset by appid, app secret and share urls
- GETget integration rules
Datasets
Get dataset
Get dataset
GET
/
v1
/
datasets
/
{dataset_id}
Copy
curl --request GET \
--url https://api.gbase.ai/v1/datasets/{dataset_id}
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"data_status": "init",
"name": "<string>",
"description": "<string>",
"metadata": "<any>",
"url_rules": "<any>",
"robots": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"discrible": "<string>",
"subject_name": "<string>",
"prompt": "<string>",
"robot_type": "rag",
"ai_type": "private",
"ai_model": "file",
"ai_status": "ready",
"apis": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"function_call_name": "<string>",
"openapi_url": "<string>",
"server_url": "<string>",
"path": "<string>",
"method": "<string>",
"header_authorization": "<any>",
"function_type": "<string>",
"function_status": "<string>",
"share_status": "<string>",
"user_id": "<string>",
"function_call_description": "<string>",
"matching_keywords": "<any>",
"llm_sta": true,
"body": "<any>",
"auth_token_curl": "<any>",
"body_required": "<any>",
"request_explanation": "<string>"
}
],
"user_id": "<string>"
}
],
"user_id": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
curl --request GET \
--url https://api.gbase.ai/v1/datasets/{dataset_id}
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"data_status": "init",
"name": "<string>",
"description": "<string>",
"metadata": "<any>",
"url_rules": "<any>",
"robots": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"discrible": "<string>",
"subject_name": "<string>",
"prompt": "<string>",
"robot_type": "rag",
"ai_type": "private",
"ai_model": "file",
"ai_status": "ready",
"apis": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"function_call_name": "<string>",
"openapi_url": "<string>",
"server_url": "<string>",
"path": "<string>",
"method": "<string>",
"header_authorization": "<any>",
"function_type": "<string>",
"function_status": "<string>",
"share_status": "<string>",
"user_id": "<string>",
"function_call_description": "<string>",
"matching_keywords": "<any>",
"llm_sta": true,
"body": "<any>",
"auth_token_curl": "<any>",
"body_required": "<any>",
"request_explanation": "<string>"
}
],
"user_id": "<string>"
}
],
"user_id": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.