# Datasets

## POST /admin/api/v1/datasets

> Create a Dataset

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/datasets":{"post":{"summary":"Create a Dataset","deprecated":false,"description":"","tags":[],"parameters":[{"name":"tenantUnitId","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tenantUnitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}},"required":["name"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}},"headers":{}}}}}},"components":{"schemas":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"tenantUnitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"status":{"type":"string"},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## GET /admin/api/v1/datasets/{datasetId}

> Get a Dataset

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/datasets/{datasetId}":{"get":{"summary":"Get a Dataset","deprecated":false,"description":"","tags":[],"parameters":[{"name":"datasetId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}},"headers":{}}}}}},"components":{"schemas":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"tenantUnitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"status":{"type":"string"},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## GET /admin/api/v1/datasets

> List Dataset

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/datasets":{"get":{"summary":"List Dataset","deprecated":false,"description":"","tags":[],"parameters":[{"name":"tenantId","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"tenantUnitId","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If no parameters are provided, all datasets will be returned.","required":false,"schema":{"type":"integer"}},{"name":"type","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}},"headers":{}}}}}},"components":{"schemas":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"tenantUnitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"status":{"type":"string"},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## DELETE /admin/api/v1/datasets/{datasetId}

> Delete dataset

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/datasets/{datasetId}":{"delete":{"summary":"Delete dataset","deprecated":false,"description":"","tags":[],"parameters":[{"name":"datasetId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"deleteDocument","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}}
```

## PATCH /admin/api/v1/datasets/{datatsetId}

> Partial update dataset

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/datasets/{datatsetId}":{"patch":{"summary":"Partial update dataset","deprecated":false,"description":"","tags":[],"parameters":[{"name":"datatsetId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}},"headers":{}}}}}},"components":{"schemas":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"tenantUnitId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"status":{"type":"string"},"type":{"type":"string","description":"knowledge or qa"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```