Datasets

Create and manage datasets for batch and sweep test runs.

6 endpoints

POST/datasets

Create a new dataset for organizing test data.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the dataset
description	string	optional	Optional description

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"UK Phone Numbers","description":"Production IVR numbers for testing"}' \
  https://api.nopaque.co.uk/datasets

Response

json

{
  "id": "ds_abc123",
  "name": "UK Phone Numbers",
  "description": "Production IVR numbers for testing",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

GET/datasets

List all datasets in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/datasets

Response

json

{
  "datasets": [
    {
      "id": "ds_abc123",
      "name": "UK Phone Numbers",
      "createdAt": "2026-04-10T12: 00: 00Z"
    }
  ]
}

GET/datasets/{id}

Get a specific dataset by ID.

Path Parameters

Name	Type	Required	Description
id	string	required	Dataset ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/datasets/ds_abc123

Response

json

{
  "id": "ds_abc123",
  "name": "UK Phone Numbers",
  "description": "Production IVR numbers for testing",
  "itemCount": 25,
  "createdAt": "2026-04-10T12: 00: 00Z"
}

PUT/datasets/{id}

Update a dataset.

Path Parameters

Name	Type	Required	Description
id	string	required	Dataset ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
description	string	optional	Updated description

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"EU Phone Numbers"}' \
  https://api.nopaque.co.uk/datasets/ds_abc123

Response

json

{
  "id": "ds_abc123",
  "name": "EU Phone Numbers",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/datasets/{id}

Delete a dataset and all its entries.

Path Parameters

Name	Type	Required	Description
id	string	required	Dataset ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/datasets/ds_abc123

Response

json

{
  "message": "Dataset deleted successfully"
}

GET/datasets/{id}/resolve

Resolve a dataset by expanding all entries into their final values.

Path Parameters

Name	Type	Required	Description
id	string	required	Dataset ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/datasets/ds_abc123/resolve

Response

json

{
  "datasetId": "ds_abc123",
  "resolvedEntries": [
    {
      "phoneNumber": "+441234567890",
      "name": "Acme Corp Main Line"
    },
    {
      "phoneNumber": "+441234567891",
      "name": "Acme Corp Support"
    }
  ]
}