Skip to main content
POST
/
datasets
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "permission": "<string>",
  "data_source_type": "<string>",
  "indexing_technique": "<string>",
  "app_count": 123,
  "document_count": 123,
  "word_count": 123,
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": 123,
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": 123,
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "embedding_available": true
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Body

application/json
​
name
string
required

Name of the knowledge base.

​
description
string

Description of the knowledge base (optional).

​
indexing_technique
enum<string>

The indexing technique to use.

Available options:
high_quality,
economy
​
permission
enum<string>

Access permissions for the knowledge base.

Available options:
only_me,
all_team_members,
partial_members
​
provider
enum<string>

The provider of the knowledge base.

Available options:
vendor,
external
​
external_knowledge_api_id
string

ID of the external knowledge API (if provider is 'external').

​
external_knowledge_id
string

ID of the external knowledge (if provider is 'external').

​
embedding_model
string

Name of the embedding model.

​
embedding_model_provider
string

Provider of the embedding model.

​
retrieval_model
object

Response

Successfully created dataset.

​
id
string<uuid>
​
name
string
​
description
string | null
​
provider
string
​
permission
string
​
data_source_type
string | null
​
indexing_technique
string | null
​
app_count
integer
​
document_count
integer
​
word_count
integer
​
created_by
string<uuid>
​
created_at
integer
​
updated_by
string<uuid>
​
updated_at
integer
​
embedding_model
string | null
​
embedding_model_provider
string | null
​
embedding_available
boolean | null