Retrieve complete details of a dataset including configuration, provisioner state, and connected endpoints.
Request
Path parameters
The unique name of the dataset to retrieve
Authentication
Requires authentication via tenant credentials.
Response
Unique identifier (UUID) for the dataset
Dataset type name (e.g., local_file, remote_weaviate)
Full configuration for the dataset. Structure varies by dataset type.
Detailed provisioner state information (for local dataset types)
Provisioner status: stopped, starting, running, stopping, or error
Provisioner state including connection config (ports) and runtime info (container_id, etc.)
ISO 8601 timestamp when provisioner was started
ISO 8601 timestamp when provisioner was stopped
Error message if status is error
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
List of endpoints connected to this dataset
Endpoint unique identifier
curl https://your-domain.com/datasets/legal-docs \
-H "Authorization: Bearer YOUR_API_KEY"
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "legal-docs",
"dtype": "local_file",
"configuration": {
"collectionName": "LegalDocuments",
"httpPort": 8100,
"ingestionPaths": [
{
"path": "/home/user/documents/legal",
"description": "Legal documents directory"
}
],
"fileTypes": [".pdf", ".txt", ".docx"]
},
"summary": "Legal documents for RAG analysis",
"tags": "legal,documents,analysis",
"provisioner_state": {
"status": "running",
"state": {
"httpPort": 8100,
"container_id": "abc123def456",
"container_name": "chromadb-local_file"
},
"started_at": "2024-03-15T10:30:00Z",
"stopped_at": null,
"error": null
},
"created_at": "2024-03-15T10:30:00Z",
"updated_at": "2024-03-15T10:30:00Z",
"connected_endpoints": [
{
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "Legal Search API",
"slug": "legal-search"
}
]
}