Sign in
threads

Permanently unmask one PII mask dictionary entry of a thread; the value is revealed to the model and no longer masked in this thread

Changed on
post/threads/{id}/pii-masks/{maskId}/unmask

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring uuid required

The UUID of the thread

maskIdstring uuid required

The UUID of the mask dictionary entry to unmask

Response

The full updated PII mask dictionary of the thread

idstring uuid required

Unique id of the mask dictionary entry

tokenstring required

The placeholder token as it appears in message text, e.g. {{pii:PERSON_NAME_1}}

valuestring required

The original value the token stands in for

category'person_name' | 'organization' | 'location' | 'email_address' | 'phone_number' | 'url_or_ip' | 'date_time' | 'financial_account' | 'government_id' | 'nationality_religion_politics' | 'other' required

PII category of the masked value

unmaskedboolean required

Whether the user manually unmasked this entry for the thread; the token still resolves in stored messages, but the value is no longer masked going forward

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "token": "{{pii:PERSON_NAME_1}}",
    "value": "Max Mustermann"
  }
]

Changes