Skip to main content

List Raw Data

Retrieve a paginated list of all raw data items.

Endpoint​

GET https://api.platform.knowledgator.com/data/


Headers​

NameTypeDescription
KnowledgatorAPI-KeyStringYour API key
Content-TypeStringapplication/json

Request Parameters​

ParameterTypeRequiredDescription
offsetIntegerNoPagination offset (default: 0, min: 0)
limitIntegerNoMaximum results per page (default: 100, max: 10000)
nameStringNoFilter by name
typeStringNoFilter by service type: ner, text-classification, relation-extraction
formatStringNoFilter by format: jsonl, csv, parquet, json

Response​

{
"data": [
{
"id": "data-123",
"name": "Single Data Item",
"type": "ner",
"format": "jsonl",
"status": "ready",
"description": "Individual data item for NER",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"total": 1,
"offset": 0,
"limit": 100
}

Response Fields​

  • data: Array of raw data objects
    • id: Unique identifier
    • name: Data name
    • type: Service type (ner, text-classification, relation-extraction)
    • format: Data format (jsonl, csv, parquet, json)
    • status: Current status (pending, processing, ready, failed)
    • description: Optional description
    • created_at: ISO 8601 timestamp of creation
    • updated_at: ISO 8601 timestamp of last update
  • total: Total number of items matching the filter
  • offset: Current pagination offset
  • limit: Current pagination limit

Error Codes​

Status CodeDescription
200OK – Request successful.
400Bad Request – Invalid input or validation failed.
401Unauthorized – Invalid 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 result = await kg.datasets.listData({
limit: 10,
type: 'ner'
});
console.log(result.data);

Python​

from knowledgator import Knowledgator

kg = Knowledgator(api_key="YOUR_API_KEY")

result = kg.datasets.list_data(
limit=10,
type="ner"
)
print(result.data)

Python​

import requests

url = "https://api.platform.knowledgator.com/data/"
headers = {
"KnowledgatorAPI-Key": "YOUR_API_KEY"
}
params = {
"limit": 10,
"type": "ner"
}

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

cURL​

curl -X GET "https://api.platform.knowledgator.com/data/?limit=10&type=ner" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY"

Additional Information​

  • Pagination: Use offset and limit parameters to browse large data sets.
  • Filtering: Combine multiple filters to find specific records.
  • Use Cases:
    • Monitoring individual data items
    • Browsing data history
    • Integrating with external data management systems