Generator Data Preview

post

Get preview data

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

column_idstringRequired

Body

application/json

idstring · uuid · nullableOptionalDefault: null

cardinality_thresholdinteger · nullableOptionalDefault: null

rare_category_replacementstring · nullableOptionalDefault: null

clip_thresholdinteger · nullableOptionalDefault: null

localestring · nullableOptionalDefault: null

pii_mock_replaceboolean · nullableOptionalDefault: null

has_piiboolean · nullableOptionalDefault: null

generator_configone of · nullableOptionalDefault: null

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

pii_deselected_entitiesstring[] · nullableOptionalDefault: null

Responses

200

Success: Preview data

application/json

400

Message: unable to generate preview data using the settings provided

application/json

404

Column not found

application/json

503

Message: unable to fetch preview data from external service

post/api/v1/generators/{column_id}/data_preview/

HTTPcURLJavaScriptPython

POST /api/v1/generators/{column_id}/data_preview/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 390

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "cardinality_threshold": 1,
  "rare_category_replacement": "text",
  "clip_threshold": 1,
  "locale": "text",
  "pii_mock_replace": true,
  "has_pii": true,
  "generator_config": {
    "name": "text",
    "display_name": "AI synthesize",
    "params": {},
    "links": [
      {
        "association": "text",
        "params": {},
        "generator": {}
      }
    ],
    "is_default": false,
    "is_applied": true
  },
  "pii_deselected_entities": [
    "text"
  ]
}

{
  "data": []
}