Skip to main content

Get Dataset

Retrieve detailed metadata and file status for a specific dataset.

Endpoint​

GET https://api.platform.knowledgator.com/datasets/{dataset_id}/


Headers​

NameTypeDescription
KnowledgatorAPI-KeyStringYour API key
Content-TypeStringapplication/json

Request Parameters​

ParameterTypeRequiredDescription
dataset_idStringYes (path)Dataset unique identifier (UUID).

Response​

{
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"name": "test-gen-dataset",
"type": "comprehend-it",
"format": "json",
"short_description": "Product review sentiment classification",
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:51Z",
"updated_at": "2026-09-16T10:45:51Z",
"examples_count": 1,
"status": "valid",
"source": "generated",
"files": [
{
"id": "f11e0000b8c7415ebc1b8071ea6ac60a",
"size": 559,
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:53Z",
"updated_at": "2026-09-16T10:45:53Z",
"application_id": null
}
],
"generation_status": {
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"status": "succeeded",
"created_at": "2026-09-16T10:45:51.295073+00:00",
"updated_at": "2026-09-16T10:45:54.264276+00:00"
}
}

Response Fields​

  • id: Unique dataset identifier (UUID).
  • name: Dataset name.
  • type: Service task type (comprehend-it, extract-it, instruct-it).
  • format: Dataset format (json).
  • short_description: Dataset description (can be string or null).
  • created_by: Creator user identifier (UUID).
  • created_at: ISO 8601 creation timestamp.
  • updated_at: ISO 8601 last update timestamp.
  • examples_count: Number of samples in the dataset.
  • status: Dataset status (valid, invalid, pending).
  • source: Dataset origin:
    • "uploaded": Directly uploaded user dataset.
    • "generated": Synthetically generated from scratch or annotated from raw data.
    • "annotated": Pre-existing raw data that was automatically annotated.
  • files: Array of attached file records with file id, size, created_by, created_at, updated_at, and optional application_id.
  • generation_status: Generation/annotation pipeline status object (or null when source is "uploaded"):
    • id: Unique task identifier (UUID matching dataset ID).
    • status: Current pipeline state:
      • "running": Dataset is currently being generated or annotated.
      • "succeeded": Generation completed successfully; files are processed and ready.
      • "failed": Generation process encountered an error.
    • created_at: Timestamp when generation was initiated.
    • updated_at: Timestamp of the latest status transition.

📘 Uploaded vs. Generated Datasets: Datasets created directly by users via file upload (source: "uploaded") will have "generation_status": null. Datasets produced by Knowledgator generation pipelines (source: "generated" or "annotated") feature the nested generation_status object showing live progress ("running" $\to$ "succeeded" or "failed").

🔒 Access Note: The UUID d655eda9-ca67-4a86-a8bc-5b3911233c79 used throughout these examples represents an authenticated user's private dataset. Requests must include your KnowledgatorAPI-Key header.


Error Codes​

Status CodeDescription
200OK – Request successful.
400Bad Request – Invalid dataset ID format or dataset not found.
401Unauthorized – Invalid or missing API key.
500Internal Server Error – Server-side issue.

Example Usage​

SDK Usage​

💡 Dedicated SDK Guides: See Python SDK | TypeScript SDK

TypeScript / JavaScript​

import { createClient } from '@knowledgator/typescript-sdk';

const kg = createClient('YOUR_API_KEY');

const dataset = await kg.datasets.get('6babd48a-2256-4466-b16b-9fd45ba59688');
console.log(dataset.name);
console.log(dataset.status);
console.log(`Examples: ${dataset.examples_count}`);

Python SDK​

from knowledgator import Knowledgator

kg = Knowledgator(api_key="YOUR_API_KEY")

dataset = kg.datasets.get("6babd48a-2256-4466-b16b-9fd45ba59688")
print(dataset.name)
print(dataset.status)
print(f"Examples: {dataset.examples_count}")

Expected SDK Output​

Ecomm Categories v1.1
valid
Examples: 500

Python (Requests)​

import requests

url = "https://api.platform.knowledgator.com/datasets/d655eda9-ca67-4a86-a8bc-5b3911233c79/"
headers = {
"KnowledgatorAPI-Key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())

Expected Response (Python Requests)​

{
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"name": "test-gen-dataset",
"type": "comprehend-it",
"format": "json",
"short_description": "Product review sentiment classification",
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:51Z",
"updated_at": "2026-09-16T10:45:51Z",
"examples_count": 1,
"status": "valid",
"source": "generated",
"files": [
{
"id": "f11e0000b8c7415ebc1b8071ea6ac60a",
"size": 559,
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:53Z",
"updated_at": "2026-09-16T10:45:53Z",
"application_id": null
}
],
"generation_status": {
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"status": "succeeded",
"created_at": "2026-09-16T10:45:51.295073+00:00",
"updated_at": "2026-09-16T10:45:54.264276+00:00"
}
}

cURL​

curl -X GET "https://api.platform.knowledgator.com/datasets/d655eda9-ca67-4a86-a8bc-5b3911233c79/" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY"

Expected Response (cURL)​

{
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"name": "test-gen-dataset",
"type": "comprehend-it",
"format": "json",
"short_description": "Product review sentiment classification",
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:51Z",
"updated_at": "2026-09-16T10:45:51Z",
"examples_count": 1,
"status": "valid",
"source": "generated",
"files": [
{
"id": "f11e0000b8c7415ebc1b8071ea6ac60a",
"size": 559,
"created_by": "a1b2c3d4e5f67890123456789abcdef0",
"created_at": "2026-09-16T10:45:53Z",
"updated_at": "2026-09-16T10:45:53Z",
"application_id": null
}
],
"generation_status": {
"id": "d655eda9-ca67-4a86-a8bc-5b3911233c79",
"status": "succeeded",
"created_at": "2026-09-16T10:45:51.295073+00:00",
"updated_at": "2026-09-16T10:45:54.264276+00:00"
}
}