Create Dataset
Create a new dataset entry on the Knowledgator platform with an initial JSON data file.
Endpoint
POST https://api.platform.knowledgator.com/datasets/
Headers
| Name | Type | Description |
|---|---|---|
KnowledgatorAPI-Key | String | Your API key |
Content-Type | String | multipart/form-data |
Request Parameters (multipart/form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
file | Binary File | Yes | Dataset file to upload (must be valid JSON, .json). |
type | String | Yes | Service task type: comprehend-it (classification), extract-it (NER / extraction), or instruct-it (instruction tuning / text2json). |
format | String | Yes | Dataset format. Strictly json per OpenAPI schema. |
name | String | No | Dataset name (2-64 characters, regex ^[a-zA-Z0-9- .()]+$). |
short_description | String | No | Short dataset description or notes (max 1024 characters). |
Response
{
"id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "pending"
}
Response Fields
id: Unique dataset identifier (UUID).status: Initial validation and processing status (pending,valid, orinvalid).
Error Codes
| Status Code | Description |
|---|---|
201 | Created – Dataset created and file queued for processing. |
400 | Bad Request – Invalid format, illegal characters in name, or validation error. |
401 | Unauthorized – Invalid or missing API key. |
403 | Forbidden – Permission denied or subscription plan limit exceeded. |
422 | Unprocessable Entity – Validation failed (e.g. format other than json). |
500 | Internal Server Error – Server-side error. |
Example Usage
SDK Usage
💡 Dedicated SDK Guides: See Python SDK | TypeScript SDK
TypeScript / JavaScript
import { createClient } from '@knowledgator/typescript-sdk';
import { readFile } from 'fs/promises';
const kg = createClient('YOUR_API_KEY');
const fileBuffer = await readFile('./products_dataset.json');
const dataset = await kg.datasets.create({
name: "Ecomm Categories v1.1",
type: "comprehend-it",
format: "json",
short_description: "E-commerce product category classification",
file: new File([fileBuffer], 'products_dataset.json')
});
console.log(dataset.id, dataset.status);
Python SDK
from knowledgator import Knowledgator
kg = Knowledgator(api_key="YOUR_API_KEY")
with open("products_dataset.json", "rb") as f:
dataset = kg.datasets.create(
name="Ecomm Categories v1.1",
type="comprehend-it",
format="json",
short_description="E-commerce product category classification",
file=f
)
print(dataset.id, dataset.status)
Expected SDK Output
6babd48a-2256-4466-b16b-9fd45ba59688 pending
Python (Requests)
import requests
url = "https://api.platform.knowledgator.com/datasets/"
headers = {
"KnowledgatorAPI-Key": "YOUR_API_KEY"
}
data = {
"name": "Ecomm Categories v1.1",
"type": "comprehend-it",
"format": "json",
"short_description": "E-commerce product category classification"
}
with open("products_dataset.json", "rb") as f:
files = {"file": ("products_dataset.json", f, "application/json")}
response = requests.post(url, headers=headers, data=data, files=files)
print(response.json())
Expected Response (Python Requests)
{
"id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "pending"
}
cURL
curl -X POST "https://api.platform.knowledgator.com/datasets/" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY" \
-F "name=Ecomm Categories v1.1" \
-F "type=comprehend-it" \
-F "format=json" \
-F "short_description=E-commerce product category classification" \
-F "file=@products_dataset.json;type=application/json"
Expected Response (cURL)
{
"id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "pending"
}
Additional Information
- Strict JSON Format: The Knowledgator API strictly enforces
jsonfor dataset uploads. - Service Type Mapping: Use
comprehend-itfor classification,extract-itfor entity extraction / NER, andinstruct-itfor JSON instruction generation. - Status Lifecycle: A created dataset starts in
pendingstatus while the file is validated and converted into platform tensors. Once validated, status transitions tovalid.