Skip to main content
Perform a partial update on a dataset. You can update the name, summary, and/or tags. At least one field must be provided. The dataset name must remain unique per tenant.
This endpoint only updates metadata fields. Dataset configuration and type cannot be changed after creation.

​
Request

​
PATCH
string
/datasets/{name}

​
Path parameters

​
name
string
required
The current name of the dataset to update

​
Authentication

Requires authentication via tenant credentials.

​
Request body

At least one field must be provided:
​
name
string
New dataset name (must be unique per tenant)
​
summary
string
Updated summary description
​
tags
string
Updated comma-separated tags

​
Response

Returns the complete updated dataset object:
​
id
string
Unique identifier (UUID) for the dataset
​
name
string
Updated dataset name
​
dtype
string
Dataset type name (unchanged)
​
configuration
object
Dataset configuration (unchanged)
​
summary
string
Updated summary
​
tags
string
Updated tags
​
provisioner_state
object
Provisioner state information (for local dataset types)
​
created_at
string
ISO 8601 timestamp of creation (unchanged)
​
updated_at
string
ISO 8601 timestamp of last update (will be current time)
​
connected_endpoints
array
List of endpoints connected to this dataset
curl -X PATCH https://your-domain.com/datasets/legal-docs \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "name": "legal-docs-updated",
    "summary": "Updated legal documents for RAG analysis",
    "tags": "legal,documents,analysis,updated"
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "legal-docs-updated",
  "dtype": "local_file",
  "configuration": {
    "collectionName": "LegalDocuments",
    "httpPort": 8100,
    "ingestionPaths": [
      {
        "path": "/home/user/documents/legal",
        "description": "Legal documents directory"
      }
    ],
    "fileTypes": [".pdf", ".txt", ".docx"]
  },
  "summary": "Updated legal documents for RAG analysis",
  "tags": "legal,documents,analysis,updated",
  "provisioner_state": {
    "status": "running",
    "state": {
      "httpPort": 8100,
      "container_id": "abc123def456"
    },
    "started_at": "2024-03-15T10:30:00Z",
    "stopped_at": null,
    "error": null
  },
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T14:22:00Z",
  "connected_endpoints": [
    {
      "id": "650e8400-e29b-41d4-a716-446655440001",
      "name": "Legal Search API",
      "slug": "legal-search"
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us