Datasets

Manage datasets, including creating, retrieving, listing, updating, and deleting datasets. These datasets can be used for Retrieval-Augmented Generation (RAG).

Create a Dataset

post

Query parameters

tenantUnitIdstringOptionalExample: {{tenantUnitId}}

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Body

application/json

idstringOptional

tenantUnitIdstringOptional

namestringRequired

descriptionstring | nullableOptional

typestringOptional

knowledge or qa

tagsstring[]Optional

Responses

200Success

application/json

post

/admin/api/v1/datasets

HTTPcURLJavaScriptPython

POST /admin/api/v1/datasets?tenantId=text HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "name": "rdc-poc-dataset-dev",
  "tenantId": "12953d87-3c05-4b8e-b8d8-cd02149f4cee",
  "tenantUnitId": "78c8e44c-9ef2-461d-88ba-ee7783a90251",
  "description": "rdc poc dataset in dev env"
}

200Success

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

Get a Dataset

get

Path parameters

datasetIdstringRequiredExample: {{datasetId}}

Query parameters

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

200Success

application/json

get

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

HTTPcURLJavaScriptPython

GET /admin/api/v1/datasets/{datasetId}?tenantId=text HTTP/1.1
Host: api.workfx.ai
Accept: */*

200Success

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

List Dataset

get

Query parameters

tenantIdstringOptionalExample: ff9bd0ba-8de5-46e1-9303-1bd2081cfc74

tenantUnitIdstringOptionalExample: f96c6fc1-af3e-45d0-bec8-1e5525da8905

limitintegerOptional

If no parameters are provided, all datasets will be returned.

Example: 5

typestringOptional

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

200Success

application/json

get

/admin/api/v1/datasets

HTTPcURLJavaScriptPython

GET /admin/api/v1/datasets HTTP/1.1
Host: api.workfx.ai
Accept: */*

200Success

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

Delete dataset

delete

Path parameters

datasetIdstringRequiredExample: 0361d480-ac91-430e-94d4-8e3a9762675f

Query parameters

deleteDocumentstringOptionalExample: true

tenantIdstringOptionalExample: fcbb17f3-646f-41d3-a097-fdb801f73142

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

204Success

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /admin/api/v1/datasets/{datasetId} HTTP/1.1
Host: api.workfx.ai
Accept: */*

204Success

{}

Partial update dataset

patch

Path parameters

datatsetIdstringRequired

Query parameters

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Body

application/json

namestringOptional

descriptionstring | nullableOptional

typestringOptional

knowledge or qa

tagsstring[]Optional

Responses

200Success

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /admin/api/v1/datasets/{datatsetId}?tenantId=text HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "description": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

200Success

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}