typestrict.aidocs
APIDatasets

Get a dataset

GET
/v1/datasets/{id}

A dataset: its totals, the personal data masked, the agent's structure, the preparation's steps and what it needs next.

Authorization

api_key
headerAuthorizationBearer <token>

An API key from Settings (ts_...).

Path Parameters

id*string
Formatuuid

Response Body

application/json
  1. response
counts*

What came out of the upload, as totals: the sources themselves are paged (/v1/datasets/{id}/sources).

dataset*
next_action*string
pii*

Personal data found and masked, per kind (email, cpf, name...), summed over the sources.

remotes*array<>
step*integer

1 to 5, see Trainings.

Formatint32
Range0 <= value
structure?null|
timeline*array<>

The preparation's steps, with their state and timing.

curl -X GET "https://example.com/v1/datasets/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "counts": {    "documents": 0,    "files": 0,    "rows": 0,    "skipped": 0,    "tables": 0  },  "dataset": {    "anonymize": true,    "created_at": "2019-08-24T14:15:22Z",    "data_deleted_at": "2019-08-24T14:15:22Z",    "data_expire_at": "2019-08-24T14:15:22Z",    "error": "string",    "goal": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "questions": {},    "row_count": 0,    "status": "string",    "target_column": "string",    "updated_at": "2019-08-24T14:15:22Z"  },  "next_action": "string",  "pii": {},  "remotes": [    {      "error": "string",      "files": {},      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "license": "string",      "options": {},      "repo": "string",      "revision": "string",      "stats": {},      "status": "string"    }  ],  "step": 0,  "structure": null,  "timeline": [    {}  ]}