Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/openmined/syft-space/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of all datasets configured for the authenticated tenant, including provisioner status and connected endpoints.

​
Request

​
GET
string
/datasets/

​
Authentication

Requires authentication via tenant credentials.

​
Response

Returns an array of dataset items:
​
id
string
Unique identifier (UUID) for the dataset
​
name
string
Dataset name
​
dtype
string
Dataset type name (e.g., local_file, remote_weaviate)
​
summary
string
Brief description of the dataset
​
tags
string
Comma-separated tags
​
configuration
object
Full dataset configuration including type-specific settings
​
created_at
string
ISO 8601 timestamp of creation
​
connected_endpoints
array
List of endpoints connected to this dataset
​
provisioner_status
object
Provisioner status information (for local dataset types)
curl https://your-domain.com/datasets/ \
  -H "Authorization: Bearer YOUR_API_KEY"

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "legal-docs",
    "dtype": "local_file",
    "summary": "Legal documents for RAG analysis",
    "tags": "legal,documents,analysis",
    "configuration": {
      "collectionName": "LegalDocuments",
      "httpPort": 8100,
      "ingestionPaths": [
        {
          "path": "/home/user/documents/legal",
          "description": "Legal documents directory"
        }
      ],
      "fileTypes": [".pdf", ".txt", ".docx"]
    },
    "created_at": "2024-03-15T10:30:00Z",
    "connected_endpoints": [
      {
        "id": "650e8400-e29b-41d4-a716-446655440001",
        "name": "Legal Search API",
        "slug": "legal-search"
      }
    ],
    "provisioner_status": {
      "status": "running",
      "error": null
    }
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440002",
    "name": "remote-knowledge-base",
    "dtype": "remote_weaviate",
    "summary": "Remote knowledge base for semantic search",
    "tags": "knowledge,remote,search",
    "configuration": {
      "http_url": "https://weaviate.example.com",
      "grpc_url": "grpc://weaviate.example.com:50051",
      "api_key": "***",
      "collection_name": "KnowledgeBase",
      "content_property": "body",
      "metadata_properties": ["title", "author", "date"]
    },
    "created_at": "2024-03-14T09:15:00Z",
    "connected_endpoints": [],
    "provisioner_status": null
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us