{
"openapi": "3.0.3",
"info": {
"title": "Detect API",
"description": "**Note:** This API is in beta and subject to change.\n\nThis API detects and de-identifies sensitive data in the specified content.\n\nThe Detect API is available from two base URIs. *identifier* is the identifier in your vault's URL.\n\n- **Sandbox:** https://*identifier*.vault.skyflowapis-preview.com\n- **Production:** https://*identifier*.vault.skyflowapis.com\n\nThe user or service account calling the Detect API must have Detect Invoker or Vault Owner permissions for the specified vault.\n\nWhen you make an API call, you need to add an *Authorization* header:\n\n| Header | Value | Example |\n| --- | --- | --- |\n| Authorization | A Bearer Token. See [API Authentication](/docs/fundamentals/api-authentication). | `Authorization: Bearer eyJhbGciOiJSUzI...1NiIsJdfPA` |",
"license": {
"name": "Proprietary",
"url": "https://docs.skyflow.com"
},
"version": "2026.06"
},
"servers": [
{
"url": "https://{identifier}.vault.skyflowapis.com",
"description": "Production",
"variables": {
"identifier": {
"default": "{{vaultUri}}",
"description": "The unique identifier for the vault."
}
}
},
{
"url": "https://{identifier}.vault.skyflowapis-preview.com",
"description": "Sandbox",
"variables": {
"identifier": {
"default": "{{vaultUri}}",
"description": "The unique identifier for the vault."
}
}
}
],
"externalDocs": {
"description": "Guides, tutorials, and references for using Skyflow.",
"url": "https://docs.skyflow.com/"
},
"paths": {
"/v1/detect/deidentify/file": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify File",
"description": "De-identifies sensitive data from a file. This operation includes options applicable to all supported file types.
For more specific options, see the category-specific operations (like De-identify Document) and the file type-specific opertions (like De-identify PDF).
Note:
Layout may vary with token-based redaction for MS Office files (PPT, DOCX, and XLS) and PDFs when token-based PDF processing is selected.",
"operationId": "deidentify_file",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_file"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/audio": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Audio",
"description": "De-identifies sensitive data from an audio file. This operation includes options applicable to all supported audio file types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_audio",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileAudioRequest_deidentify_audio"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "mp3"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "mp3"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/document": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Document",
"description": "De-identifies sensitive data from a document file. This operation includes options applicable to all supported document file types.
For more specific options, see the file type-specific opertions (like De-identify PDF) where they're available. For broader file type support, see De-identify File.",
"operationId": "deidentify_document",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_document"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "docx"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "docx"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/document/pdf": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify PDF",
"description": "De-identifies sensitive data from a PDF file. This operation includes options specific to PDF files.
For broader file type support, see De-identify Document and De-identify File.",
"operationId": "deidentify_pdf",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileDocumentPdfRequest_deidentify_pdf"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "pdf"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "pdf"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/image": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Image",
"description": "De-identifies sensitive data from an image file. This operation includes options applicable to all supported image file types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_image",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileImageRequest_deidentify_image"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "jpg"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "jpg"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/presentation": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Presentation",
"description": "De-identifies sensitive data from a presentation file. This operation includes options applicable to all supported presentation file types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_presentation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_presentation"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "pptx"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "pptx"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/spreadsheet": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Spreadsheet",
"description": "De-identifies sensitive data from a spreadsheet file. This operation includes options applicable to all supported spreadsheet file types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_spreadsheet",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_spreadsheet"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "csv"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "csv"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/structured_text": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Structured Text",
"description": "De-identifies sensitive data from a structured text file. This operation includes options applicable to all supported structured text file types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_structured_text",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_structured_text"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "json"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "json"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/file/text": {
"post": {
"tags": [
"Files V1"
],
"summary": "De-identify Text",
"description": "De-identifies sensitive data from a text file. This operation includes options applicable to all supported image text types.
For broader file type support, see De-identify File.",
"operationId": "deidentify_text",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequest_deidentify_text"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"run_id": "8e1f02be-95f1-4868-af33-3c8419bd0d73"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/deidentify/string": {
"post": {
"tags": [
"Strings V1"
],
"summary": "De-identify String",
"description": "De-identifies sensitive data from a string.",
"operationId": "deidentify_string",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyStringRequest"
},
"examples": {
"Placeholders": {
"value": {
"vault_id": "$VAULT_ID",
"text": "My name is John Doe, and my email is johndoe@acme.com."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyStringResponse"
},
"examples": {
"Placeholders": {
"value": {
"processed_text": "My name is [NAME_1] and my email is [EMAIL_ADDRESS_1].",
"word_count": 10,
"character_count": 53,
"entities": [
{
"token": "NAME_1",
"value": "John Doe",
"location": {
"start_index": 11,
"end_index": 19,
"start_index_processed": 11,
"end_index_processed": 19
},
"entity_type": "NAME",
"entity_scores": {
"NAME": 0.9152,
"NAME_FAMILY": 0.4583,
"NAME_GIVEN": 0.4457
}
},
{
"token": "EMAIL_ADDRESS_1",
"value": "johndoe@acme.com",
"location": {
"start_index": 36,
"end_index": 52,
"start_index_processed": 36,
"end_index_processed": 53
},
"entity_type": "EMAIL_ADDRESS",
"entity_scores": {
"EMAIL_ADDRESS": 0.8955
}
}
]
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"vault_id": "$VAULT_ID",
"text": "My name is John Doe, and my email is johndoe@acme.com."
}
},
"response": {
"200": {
"body": {
"processed_text": "My name is [NAME_1] and my email is [EMAIL_ADDRESS_1].",
"word_count": 10,
"character_count": 53,
"entities": [
{
"token": "NAME_1",
"value": "John Doe",
"location": {
"start_index": 11,
"end_index": 19,
"start_index_processed": 11,
"end_index_processed": 19
},
"entity_type": "NAME",
"entity_scores": {
"NAME": 0.9152,
"NAME_FAMILY": 0.4583,
"NAME_GIVEN": 0.4457
}
},
{
"token": "EMAIL_ADDRESS_1",
"value": "johndoe@acme.com",
"location": {
"start_index": 36,
"end_index": 52,
"start_index_processed": 36,
"end_index_processed": 53
},
"entity_type": "EMAIL_ADDRESS",
"entity_scores": {
"EMAIL_ADDRESS": 0.8955
}
}
]
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/guardrails": {
"post": {
"tags": [
"Guardrails V1"
],
"summary": "Check Guardrails",
"description": "Preserve safety and compliance with usage policies.",
"operationId": "check_guardrails",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectGuardrailsRequest"
},
"examples": {
"Placeholders": {
"value": {
"vault_id": "$VAULT_ID",
"text": "I love to play cricket.",
"check_toxicity": true,
"deny_topics": [
"sports"
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectGuardrailsResponse"
},
"examples": {
"Placeholders": {
"value": {
"text": "I love to play cricket.",
"toxic": false,
"denied_topic": true,
"validation": "failed"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"vault_id": "$VAULT_ID",
"text": "I love to play cricket.",
"check_toxicity": true,
"deny_topics": [
"sports"
]
}
},
"response": {
"200": {
"body": {
"text": "I love to play cricket.",
"toxic": false,
"denied_topic": true,
"validation": "failed"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/reidentify/file": {
"post": {
"tags": [
"Files V1"
],
"summary": "Re-identify File",
"description": "Re-identifies tokens in a file.",
"operationId": "reidentify_file",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyFileRequest_reidentify_file"
},
"examples": {
"Placeholders": {
"value": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyFileResponse"
},
"examples": {
"Placeholders": {
"value": {
"status": "success",
"output_type": "BASE64",
"output": {
"processed_file": "$PROCESSED_FILE",
"processed_file_type": "reidentified_file",
"processed_file_extension": "txt"
}
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"file": {
"base64": "$BASE64_DATA",
"data_format": "txt"
},
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"status": "success",
"output_type": "BASE64",
"output": {
"processed_file": "$PROCESSED_FILE",
"processed_file_type": "reidentified_file",
"processed_file_extension": "txt"
}
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/reidentify/string": {
"post": {
"tags": [
"Strings V1"
],
"summary": "Re-identify String",
"description": "Re-identifies tokens in a string.",
"operationId": "reidentify_string",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyStringRequest"
},
"examples": {
"Placeholders": {
"value": {
"text": "My name is [NAME_1], and my email is [EMAIL_1].",
"vault_id": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentifyResponse"
},
"examples": {
"Placeholders": {
"value": {
"text": "My name is John Doe, and my email is johndoe@acme.com"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"text": "My name is [NAME_1], and my email is [EMAIL_1].",
"vault_id": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"text": "My name is John Doe, and my email is johndoe@acme.com"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v1/detect/runs/{run_id}": {
"get": {
"tags": [
"Files V1"
],
"summary": "Get Detect Run",
"description": "Returns the status of a detect run.",
"operationId": "get_run",
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vault_id",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectRunsResponse"
},
"examples": {
"Placeholders": {
"value": {
"status": "success",
"output_type": "efs_path",
"output": [
{
"processed_file": "$REDACTED_TEXT_URL",
"processed_file_type": "redacted_text"
},
{
"processed_file": "$ENTITIES_URL",
"processed_file_type": "entities"
}
],
"message": "De-identification completed successfully."
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"vault_id"
],
"x-required-query-parameters": [
"vault_id"
],
"x-examples": [
{
"name": "Placeholders",
"response": {
"200": {
"body": {
"status": "success",
"output_type": "efs_path",
"output": [
{
"processed_file": "$REDACTED_TEXT_URL",
"processed_file_type": "redacted_text"
},
{
"processed_file": "$ENTITIES_URL",
"processed_file_type": "entities"
}
],
"message": "De-identification completed successfully."
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/deidentify/file": {
"post": {
"tags": [
"Files V2"
],
"summary": "De-identify File V2",
"description": "De-identifies sensitive data from a file.
Note:\n- Layout may vary with token-based redaction for MS Office files (PPT, DOCX, and XLS) and PDFs when token-based PDF processing is selected.\n- V2 API is in beta and feature-flagged.",
"operationId": "deidentify_file_v2",
"requestBody": {
"description": "Request to de-identify a file. Provide either `configurationId` or `configuration` — only one is required.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileRequestV2"
},
"examples": {
"Placeholders": {
"value": {
"dataSource": "BASE64",
"value": "$BASE64_DATA",
"dataFormat": "pdf",
"configurationId": "$CONFIGURATION_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyFileResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"runId": "$RUN_ID"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"dataSource": "BASE64",
"value": "$BASE64_DATA",
"dataFormat": "pdf",
"configurationId": "$CONFIGURATION_ID"
}
},
"response": {
"200": {
"body": {
"runId": "$RUN_ID"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/deidentify/string": {
"post": {
"tags": [
"Strings V2"
],
"summary": "De-identify String V2",
"description": "De-identifies sensitive data from a string.
Note: V2 API is in beta and feature-flagged.",
"operationId": "deidentify_string_v2",
"requestBody": {
"description": "Request to de-identify a string. Provide either `configurationId` or `configuration` — only one is required.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyStringRequestV2"
},
"examples": {
"Placeholders": {
"value": {
"text": "My name is John Doe, and my email is johndoe@acme.com.",
"configurationId": "$CONFIGURATION_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeidentifyStringResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"processedText": "My name is [NAME_1] and my email is [EMAIL_ADDRESS_1].",
"entities": [
{
"token": "NAME_1",
"value": "John Doe",
"location": {
"startIndex": 11,
"endIndex": 19,
"startIndexProcessed": 11,
"endIndexProcessed": 19
},
"entityType": "NAME",
"entityScores": {
"NAME": 0.9152
}
},
{
"token": "EMAIL_ADDRESS_1",
"value": "johndoe@acme.com",
"location": {
"startIndex": 36,
"endIndex": 52,
"startIndexProcessed": 36,
"endIndexProcessed": 53
},
"entityType": "EMAIL_ADDRESS",
"entityScores": {
"EMAIL_ADDRESS": 0.8955
}
}
],
"metrics": {
"size": 0.05,
"wordCount": 10,
"characterCount": 53
}
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"text": "My name is John Doe, and my email is johndoe@acme.com.",
"configurationId": "$CONFIGURATION_ID"
}
},
"response": {
"200": {
"body": {
"processedText": "My name is [NAME_1] and my email is [EMAIL_ADDRESS_1].",
"entities": [
{
"token": "NAME_1",
"value": "John Doe",
"location": {
"startIndex": 11,
"endIndex": 19,
"startIndexProcessed": 11,
"endIndexProcessed": 19
},
"entityType": "NAME",
"entityScores": {
"NAME": 0.9152
}
},
{
"token": "EMAIL_ADDRESS_1",
"value": "johndoe@acme.com",
"location": {
"startIndex": 36,
"endIndex": 52,
"startIndexProcessed": 36,
"endIndexProcessed": 53
},
"entityType": "EMAIL_ADDRESS",
"entityScores": {
"EMAIL_ADDRESS": 0.8955
}
}
],
"metrics": {
"size": 0.05,
"wordCount": 10,
"characterCount": 53
}
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/guardrails": {
"post": {
"tags": [
"Guardrails V2"
],
"summary": "Check Guardrails V2",
"description": "Preserve safety and compliance with usage policies.
Note: V2 API is in beta and feature-flagged.",
"operationId": "check_guardrails_v2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectGuardrailsRequestV2"
},
"examples": {
"Placeholders": {
"value": {
"vault_id": "$VAULT_ID",
"text": "I love to play cricket.",
"check_toxicity": true,
"deny_topics": [
"sports"
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectGuardrailsResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"text": "I love to play cricket.",
"toxic": false,
"denied_topic": true,
"validation": "failed"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"vault_id": "$VAULT_ID",
"text": "I love to play cricket.",
"check_toxicity": true,
"deny_topics": [
"sports"
]
}
},
"response": {
"200": {
"body": {
"text": "I love to play cricket.",
"toxic": false,
"denied_topic": true,
"validation": "failed"
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/reidentify/file": {
"post": {
"tags": [
"Files V2"
],
"summary": "Re-identify File V2",
"description": "Re-identifies tokens in a file.
Note: V2 API is in beta and feature-flagged.",
"operationId": "reidentify_file_v2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyFileRequestV2"
},
"examples": {
"Placeholders": {
"value": {
"dataSource": "BASE64",
"value": "$BASE64_DATA",
"dataFormat": "txt",
"vaultId": "$VAULT_ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyFileResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"status": "SUCCESS",
"outputType": "BASE64",
"output": [
{
"processedFile": "$PROCESSED_FILE",
"processedFileType": "REIDENTIFIED_FILE",
"processedFileExtension": "txt"
}
]
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"dataSource": "BASE64",
"value": "$BASE64_DATA",
"dataFormat": "txt",
"vaultId": "$VAULT_ID"
}
},
"response": {
"200": {
"body": {
"status": "SUCCESS",
"outputType": "BASE64",
"output": [
{
"processedFile": "$PROCESSED_FILE",
"processedFileType": "REIDENTIFIED_FILE",
"processedFileExtension": "txt"
}
]
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/reidentify/string": {
"post": {
"tags": [
"Strings V2"
],
"summary": "Re-identify String V2",
"description": "Re-identifies tokens in a string.
Note: V2 API is in beta and feature-flagged.",
"operationId": "reidentify_string_v2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyStringRequestV2"
},
"examples": {
"Placeholders": {
"value": {
"vaultId": "$VAULT_ID",
"text": "My name is [NAME_1], and my email is [EMAIL_ADDRESS_1]."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReidentifyStringResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"processedText": "My name is John Doe, and my email is johndoe@acme.com."
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-examples": [
{
"name": "Placeholders",
"request": {
"body": {
"vaultId": "$VAULT_ID",
"text": "My name is [NAME_1], and my email is [EMAIL_ADDRESS_1]."
}
},
"response": {
"200": {
"body": {
"processedText": "My name is John Doe, and my email is johndoe@acme.com."
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
},
"/v2/detect/runs/{runId}": {
"get": {
"tags": [
"Files V2"
],
"summary": "Get Detect Run V2",
"description": "Returns the status of a detect run.
Note: V2 API is in beta and feature-flagged.",
"operationId": "get_run_v2",
"parameters": [
{
"name": "runId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vaultId",
"in": "query",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DetectRunsResponseV2"
},
"examples": {
"Placeholders": {
"value": {
"status": "SUCCESS",
"outputType": "PRESIGNED_URL",
"output": [
{
"processedFile": "$REDACTED_TEXT_URL",
"processedFileType": "REDACTED_TEXT"
},
{
"processedFile": "$ENTITIES_URL",
"processedFileType": "ENTITIES"
}
],
"message": "De-identification completed successfully."
}
}
}
}
},
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"500": {
"$ref": "#/components/responses/500"
}
},
"security": [
{
"Bearer": []
}
],
"x-external-query-parameters": [
"vaultId"
],
"x-required-query-parameters": [
"vaultId"
],
"x-examples": [
{
"name": "Placeholders",
"response": {
"200": {
"body": {
"status": "SUCCESS",
"outputType": "PRESIGNED_URL",
"output": [
{
"processedFile": "$REDACTED_TEXT_URL",
"processedFileType": "REDACTED_TEXT"
},
{
"processedFile": "$ENTITIES_URL",
"processedFileType": "ENTITIES"
}
],
"message": "De-identification completed successfully."
}
}
}
}
],
"x-fern-audiences": [
"external"
]
}
}
},
"components": {
"schemas": {
"AudioV2": {
"type": "object",
"properties": {
"outputProcessedAudio": {
"type": "boolean",
"default": true,
"description": "If `true`, includes processed audio file in the response."
},
"outputTranscription": {
"enum": [
"NONE",
"TRANSCRIPTION",
"MEDICAL_TRANSCRIPTION",
"DIARIZED_TRANSCRIPTION",
"MEDICAL_DIARIZED_TRANSCRIPTION"
],
"type": "string",
"default": "NONE",
"description": "Transcription type to include in the response.",
"format": "enum"
},
"bleep": {
"$ref": "#/components/schemas/AudioV2_Bleep"
}
},
"description": "Audio detection and deidentification configuration.",
"x-visibility": [
"external"
]
},
"AudioV2_Bleep": {
"type": "object",
"properties": {
"startPadding": {
"maximum": 20,
"type": "number",
"default": 0.5,
"description": "Padding added to the beginning of a bleep, in seconds. Range: 0–20. Defaults to 0.5.",
"format": "float"
},
"stopPadding": {
"maximum": 20,
"type": "number",
"default": 0.2,
"description": "Padding added to the end of a bleep, in seconds. Range: 0–20. Defaults to 0.2.",
"format": "float"
},
"frequency": {
"maximum": 20000,
"minimum": 20,
"type": "integer",
"default": 600,
"description": "Frequency of the sine wave used for the bleep sound, in Hz.",
"format": "int32"
},
"gain": {
"minimum": -60,
"type": "integer",
"default": -3,
"description": "Relative loudness of the bleep. Positive values increase loudness and negative values decrease it.",
"format": "int32"
}
},
"description": "Configuration for the bleep sound used to mask detected entities in audio.",
"x-visibility": [
"external"
]
},
"DeidentifiedFileOutput": {
"type": "object",
"properties": {
"processedFile": {
"type": "string",
"description": "File content in Base64 format."
},
"processedFileType": {
"enum": [
"redacted_audio",
"redacted_image",
"redacted_transcription",
"redacted_file",
"redacted_text",
"entities",
"redacted_transcription_diarize_json"
],
"type": "string",
"description": "Type of the processed file.",
"format": "enum"
},
"processedFileExtension": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"zip",
"gif"
],
"type": "string",
"description": "Extension of the processed file.",
"format": "enum"
}
},
"description": "Details of output files. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"DeidentifyFileRequestV2": {
"required": [
"dataSource",
"value",
"configurationId",
"dataFormat"
],
"type": "object",
"properties": {
"dataSource": {
"enum": [
"BASE64",
"SKYFLOW_ID",
"PRESIGNED_URL"
],
"type": "string",
"description": "Data source of the input file. `BASE64`: Base64-encoded file string. `SKYFLOW_ID`: Reference file by vault ID. `PRESIGNED_URL`: S3 presigned URL of input file.",
"format": "enum"
},
"value": {
"type": "string",
"description": "File data corresponding to the specified `dataSource` type."
},
"dataFormat": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"zip",
"gif"
],
"type": "string",
"description": "Format of the input file.",
"format": "enum"
},
"configurationId": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification."
},
"configuration": {
"$ref": "#/components/schemas/DetectConfigV2"
}
},
"description": "De-identifies sensitive data in a file. Provide either `configurationId` or `configuration` — only one is required.",
"x-visibility": [
"external"
]
},
"DeidentifyFileResponse": {
"type": "object",
"properties": {
"run_id": {
"type": "string",
"description": "Status URL for the Detect run."
}
},
"description": "Response to deidentify a file."
},
"DeidentifyFileResponseV2": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"description": "Run ID of the deidentification request."
}
},
"description": "Response containing the run ID for tracking the async deidentification job."
},
"DeidentifyStringRequest": {
"example": {
"text": [
"S: 62yo female here for first visit. No concerns today. Her FP (Dr. Benyamin) is retiring soon. Up to date on pap, mammo, labs, BMD. On the waitlist for colonoscopy. Past Medical and Surgical hx: nil. Meds: nil. Allergies: Pn. Family and Social hx: see CPP. O: Temp 35.2;BP 145-73; HR 58. Appears well. A: First visit. P: CPP updated. RTC prn. A007. First visit. Type Name: Clinical Note"
],
"vault_id": "f4b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
},
"required": [
"text",
"vault_id"
],
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Text to de-identify."
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "String Request to deidentify a string."
},
"DeidentifyStringRequestV2": {
"required": [
"text",
"configurationId"
],
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Text to deidentify."
},
"configurationId": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification."
},
"configuration": {
"$ref": "#/components/schemas/DetectConfigV2"
}
},
"description": "De-identifies sensitive data in a string. Provide either `configurationId` or `configuration` — only one is required.",
"x-visibility": [
"external"
]
},
"DeidentifyStringResponse": {
"example": {
"word_count": 70,
"character_count": 552,
"entities": [
{
"best_label": "NAME",
"labels": {
"NAME": 0.8016
},
"location": {
"end_index": 1,
"end_index_processed": 8,
"start_idx": 0,
"start_idx_processed": 0
},
"value": "S",
"token": "NAME_1"
},
{
"best_label": "AGE",
"labels": {
"AGE": 0.9003
},
"location": {
"end_index": 7,
"end_index_processed": 17,
"start_idx": 3,
"start_idx_processed": 10
},
"value": "62yo",
"token": "AGE_1"
},
{
"best_label": "GENDER_SEXUALITY",
"labels": {
"GENDER_SEXUALITY": 0.9487
},
"location": {
"end_index": 14,
"end_index_processed": 38,
"start_idx": 8,
"start_idx_processed": 18
},
"value": "female",
"token": "GENDER_SEXUALITY_1"
},
{
"best_label": "OCCUPATION",
"labels": {
"OCCUPATION": 0.6695
},
"location": {
"end_index": 62,
"end_index_processed": 98,
"start_idx": 60,
"start_idx_processed": 84
},
"value": "FP",
"token": "OCCUPATION_1"
},
{
"best_label": "OCCUPATION",
"labels": {
"OCCUPATION": 0.9102
},
"location": {
"end_index": 66,
"end_index_processed": 114,
"start_idx": 64,
"start_idx_processed": 100
},
"value": "Dr",
"token": "OCCUPATION_2"
},
{
"best_label": "NAME_FAMILY",
"labels": {
"NAME": 0.9109,
"NAME_FAMILY": 0.8204
},
"location": {
"end_index": 76,
"end_index_processed": 131,
"start_idx": 68,
"start_idx_processed": 116
},
"value": "Benyamin",
"token": "NAME_FAMILY_1"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.9443
},
"location": {
"end_index": 113,
"end_index_processed": 184,
"start_idx": 110,
"start_idx_processed": 165
},
"value": "pap",
"token": "MEDICAL_PROCESS_1"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.9415
},
"location": {
"end_index": 120,
"end_index_processed": 205,
"start_idx": 115,
"start_idx_processed": 186
},
"value": "mammo",
"token": "MEDICAL_PROCESS_2"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.9361
},
"location": {
"end_index": 126,
"end_index_processed": 226,
"start_idx": 122,
"start_idx_processed": 207
},
"value": "labs",
"token": "MEDICAL_PROCESS_3"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.9304
},
"location": {
"end_index": 131,
"end_index_processed": 247,
"start_idx": 128,
"start_idx_processed": 228
},
"value": "BMD",
"token": "MEDICAL_PROCESS_4"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.9374
},
"location": {
"end_index": 164,
"end_index_processed": 288,
"start_idx": 153,
"start_idx_processed": 269
},
"value": "colonoscopy",
"token": "MEDICAL_PROCESS_5"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.5688
},
"location": {
"end_index": 178,
"end_index_processed": 314,
"start_idx": 171,
"start_idx_processed": 295
},
"value": "Medical",
"token": "MEDICAL_PROCESS_6"
},
{
"best_label": "MEDICAL_PROCESS",
"labels": {
"MEDICAL_PROCESS": 0.5271
},
"location": {
"end_index": 194,
"end_index_processed": 338,
"start_idx": 183,
"start_idx_processed": 319
},
"value": "Surgical hx",
"token": "MEDICAL_PROCESS_7"
},
{
"best_label": "CONDITION",
"labels": {
"CONDITION": 0.9266
},
"location": {
"end_index": 221,
"end_index_processed": 369,
"start_idx": 212,
"start_idx_processed": 356
},
"value": "Allergies",
"token": "CONDITION_1"
},
{
"best_label": "HEALTHCARE_NUMBER",
"labels": {
"HEALTHCARE_NUMBER": 0.7927
},
"location": {
"end_index": 348,
"end_index_processed": 513,
"start_idx": 344,
"start_idx_processed": 492
},
"value": "A007",
"token": "HEALTHCARE_NUMBER_1"
}
],
"processed_text": "[NAME_1]: [AGE_1] [GENDER_SEXUALITY_1] here for first visit. No concerns today. Her [OCCUPATION_1] ([OCCUPATION_2]. [NAME_FAMILY_1]) is retiring soon. Up to date on [MEDICAL_PROCESS_1], [MEDICAL_PROCESS_2], [MEDICAL_PROCESS_3], [MEDICAL_PROCESS_4]. On the waitlist for [MEDICAL_PROCESS_5]. Past [MEDICAL_PROCESS_6] and [MEDICAL_PROCESS_7]: nil. Meds: nil. [CONDITION_1]: Pn. Family and Social hx: see CPP. O: Temp 35.2;BP 145-73; HR 58. Appears well. A: First visit. P: CPP updated. RTC prn. [HEALTHCARE_NUMBER_1]. First visit. Type Name: Clinical Note"
},
"type": "object",
"properties": {
"processed_text": {
"type": "string",
"description": "De-identified text."
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringResponseEntities"
},
"description": "Detected entities."
},
"word_count": {
"type": "integer",
"description": "Number of words from the input text.",
"format": "int32"
},
"character_count": {
"type": "integer",
"description": "Number of characters from the input text.",
"format": "int32"
}
},
"description": "Response to deidentify a string."
},
"DeidentifyStringResponseV2": {
"type": "object",
"properties": {
"processedText": {
"type": "string",
"description": "Deidentified text with sensitive entities replaced."
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeidentifyStringResponseV2_DetectedEntity"
},
"description": "Detected entities."
},
"metrics": {
"$ref": "#/components/schemas/Metrics"
}
},
"description": "Response containing the deidentified string and detected entity metadata."
},
"DeidentifyStringResponseV2_DetectedEntity": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Processed text of the entity."
},
"value": {
"type": "string",
"description": "Original text of the entity."
},
"location": {
"$ref": "#/components/schemas/DeidentifyStringResponseV2_EntityLocation"
},
"entityType": {
"type": "string",
"description": "Highest-rated label."
},
"entityScores": {
"type": "object",
"additionalProperties": {
"maximum": 1,
"type": "number"
},
"description": "Labels and their scores."
}
},
"description": "Detected entities for String"
},
"DeidentifyStringResponseV2_EntityLocation": {
"type": "object",
"properties": {
"startIndex": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the first character of the string in the original text.",
"format": "int32"
},
"endIndex": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the last character of the string in the original text.",
"format": "int32"
},
"startIndexProcessed": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the first character of the string in the processed text.",
"format": "int32"
},
"endIndexProcessed": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the last character of the string in the processed text.",
"format": "int32"
}
},
"description": "Locations of an entity in the text.",
"x-visibility": [
"external"
]
},
"Detect": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_Entity"
},
"description": "Entities and their deidentification settings."
},
"objectEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_ObjectEntity"
},
"description": "Object entities and their deidentification settings."
},
"restrict": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `skip` and `restrict`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict` pattern only matches a substring of it, the `restrict` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"skip": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `skip` and `restrict`, the entity is displayed in plaintext."
},
"customTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Detect_CustomTypes"
},
"description": "Custom entity type definitions."
},
"returnEntities": {
"enum": [
"EXCLUDE_SENSITIVE_DATA",
"ALL",
"NONE"
],
"type": "string",
"default": "EXCLUDE_SENSITIVE_DATA",
"description": "Controls which entities are returned in the response.",
"format": "enum"
}
},
"description": "Entity detection and deidentification settings.",
"x-visibility": [
"external"
]
},
"DetectConfigV2": {
"required": [
"vaultId"
],
"type": "object",
"properties": {
"ID": {
"readOnly": true,
"type": "string",
"description": "ID of the configuration."
},
"name": {
"type": "string",
"description": "Name of the configuration."
},
"namespace": {
"readOnly": true,
"type": "string",
"description": "Namespace of the configuration."
},
"description": {
"type": "string",
"description": "Description of the configuration."
},
"vaultId": {
"type": "string",
"description": "ID of the vault."
},
"vaultType": {
"readOnly": true,
"enum": [
"NONE",
"PRIVACYDB",
"FLOWDB",
"FLOWDB_SCHEMALESS"
],
"type": "string",
"description": "Type of the vault.",
"format": "enum"
},
"detect": {
"$ref": "#/components/schemas/Detect"
},
"fileMapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileMapping"
},
"description": "Mappings for source and deidentified file locations."
},
"media": {
"$ref": "#/components/schemas/Media"
}
},
"description": "Configuration for detecting and deidentifying entities in a vault.",
"x-visibility": [
"external"
]
},
"DetectGuardrailsRequest": {
"required": [
"vault_id",
"text"
],
"type": "object",
"properties": {
"text": {
"maxLength": 500000,
"type": "string",
"description": "Text to check against guardrails."
},
"check_toxicity": {
"type": "boolean",
"default": true,
"description": "If `true`, checks for toxicity in the text."
},
"deny_topics": {
"maxItems": 100,
"type": "array",
"items": {
"maxLength": 60,
"type": "string"
},
"description": "List of topics to deny."
},
"vault_id": {
"type": "string",
"description": "ID of the vault."
}
}
},
"DetectGuardrailsRequestV2": {
"required": [
"vaultId",
"text"
],
"type": "object",
"properties": {
"text": {
"maxLength": 500000,
"type": "string",
"description": "Text to check against guardrails."
},
"checkToxicity": {
"type": "boolean",
"default": true,
"description": "If `true`, checks for toxicity in the text."
},
"denyTopics": {
"maxItems": 100,
"type": "array",
"items": {
"maxLength": 60,
"type": "string"
},
"description": "List of topics to deny."
},
"vaultId": {
"type": "string",
"description": "ID of the vault."
}
},
"description": "Request Object for detect guardrails"
},
"DetectGuardrailsResponse": {
"required": [
"text",
"validation"
],
"type": "object",
"properties": {
"text": {
"maxLength": 500000,
"type": "string",
"description": "Text that was checked against guardrails."
},
"toxic": {
"type": "boolean",
"description": "Whether the text is toxic."
},
"denied_topic": {
"type": "boolean",
"description": "Whether the text included a denied topic."
},
"validation": {
"enum": [
"failed",
"passed"
],
"type": "string",
"description": "Whether the text passed validation.",
"format": "enum"
}
}
},
"DetectGuardrailsResponseV2": {
"required": [
"text",
"validation"
],
"type": "object",
"properties": {
"text": {
"maxLength": 500000,
"type": "string",
"description": "Text that was checked against guardrails."
},
"toxic": {
"type": "boolean",
"description": "Whether the text is toxic."
},
"deniedTopic": {
"type": "boolean",
"description": "Whether the text included a denied topic."
},
"validation": {
"enum": [
"FAILED",
"PASSED"
],
"type": "string",
"description": "Whether the text passed validation.",
"format": "enum"
}
},
"description": "Response object for detect guardrails"
},
"DetectRunsResponse": {
"type": "object",
"properties": {
"status": {
"enum": [
"UNKNOWN",
"FAILED",
"SUCCESS",
"IN_PROGRESS"
],
"type": "string",
"description": "Status of the operation.",
"format": "enum"
},
"outputType": {
"enum": [
"UNKNOWN",
"BASE64"
],
"type": "string",
"description": "Format of the output file.",
"format": "enum"
},
"output": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeidentifiedFileOutput"
},
"description": "Details of output files. Files are specified as Base64-encoded data."
},
"message": {
"maxLength": 1000,
"type": "string",
"description": "Status details about the Detect run."
},
"size": {
"type": "number",
"description": "Size of the processed file in kilobytes (KB).",
"format": "float"
},
"wordCharacterCount": {
"$ref": "#/components/schemas/WordCharacterCount"
},
"duration": {
"type": "number",
"description": "Duration of the processed audio in seconds.",
"format": "float"
},
"pages": {
"type": "integer",
"description": "Number of pages in the processed PDF.",
"format": "int32"
},
"slides": {
"type": "integer",
"description": "Number of slides in the processed presentation.",
"format": "int32"
}
},
"description": "Response to get the status of a file deidentification request."
},
"DetectRunsResponseV2": {
"type": "object",
"properties": {
"status": {
"enum": [
"UNKNOWN",
"FAILED",
"SUCCESS",
"IN_PROGRESS"
],
"type": "string",
"description": "Status of the detect run.",
"format": "enum"
},
"outputType": {
"enum": [
"BASE64",
"SKYFLOW_ID",
"PRESIGNED_URL"
],
"type": "string",
"description": "Data source of the output file. `BASE64`: Base64-encoded file string. `SKYFLOW_ID`: Reference file by vault ID. `PRESIGNED_URL`: S3 presigned URL of input file.",
"format": "enum"
},
"output": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileOutput"
},
"description": "Details of output files."
},
"message": {
"type": "string",
"description": "Status details about the Detect run."
},
"metrics": {
"$ref": "#/components/schemas/Metrics"
}
},
"description": "Response containing the status and output of a v2 detect run."
},
"Detect_CustomTypes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label of the custom type. Note: Vault tokens are currently not supported."
},
"match": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[]' enclosed in square brackets. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be redacted. Expressions don't match across entity boundaries. If a string or entity matches both `skip` and `customType.label`, the entity is displayed in plaintext. If a string is detected as an entity and a `customType.match` pattern matches the entire detected entity, the entity is replaced with '[]'. If a string is detected as an entity but a `customType.match` pattern only matches a substring of it, the `customType.match` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings."
}
},
"description": "Custom entity type defined by a label and a list of match values."
},
"Detect_Entity": {
"type": "object",
"properties": {
"entityType": {
"enum": [
"NONE",
"BANK_ACCOUNT",
"CREDIT_CARD",
"CREDIT_CARD_EXPIRATION",
"CVV",
"DATE",
"DATE_INTERVAL",
"DOB",
"DRIVER_LICENSE",
"EMAIL_ADDRESS",
"HEALTHCARE_NUMBER",
"IP_ADDRESS",
"LOCATION",
"NAME",
"NUMERICAL_PII",
"PHONE_NUMBER",
"SSN",
"URL",
"VEHICLE_ID",
"MEDICAL_CODE",
"NAME_FAMILY",
"NAME_GIVEN",
"ACCOUNT_NUMBER",
"EVENT",
"FILENAME",
"GENDER",
"LANGUAGE",
"LOCATION_ADDRESS",
"LOCATION_CITY",
"LOCATION_COORDINATE",
"LOCATION_COUNTRY",
"LOCATION_STATE",
"LOCATION_ZIP",
"MARITAL_STATUS",
"MONEY",
"NAME_MEDICAL_PROFESSIONAL",
"OCCUPATION",
"ORGANIZATION",
"ORGANIZATION_MEDICAL_FACILITY",
"ORIGIN",
"PASSPORT_NUMBER",
"PASSWORD",
"PHYSICAL_ATTRIBUTE",
"POLITICAL_AFFILIATION",
"RELIGION",
"TIME",
"USERNAME",
"ZODIAC_SIGN",
"BLOOD_TYPE",
"CONDITION",
"DOSE",
"DRUG",
"INJURY",
"MEDICAL_PROCESS",
"STATISTICS",
"ROUTING_NUMBER",
"CORPORATE_ACTION",
"FINANCIAL_METRIC",
"PRODUCT",
"TREND",
"DURATION",
"LOCATION_ADDRESS_STREET",
"AGE",
"SEXUALITY",
"EFFECT",
"PROJECT",
"ORGANIZATION_ID",
"DAY",
"MONTH",
"YEAR",
"ALL"
],
"type": "string",
"default": "ALL",
"description": "Type of entity to detect.",
"format": "enum"
},
"deidentificationType": {
"enum": [
"UNKNOWN",
"ENTITY_UNIQUE_COUNTER",
"ENTITY_ONLY",
"VAULT_TOKEN"
],
"type": "string",
"default": "ENTITY_UNIQUE_COUNTER",
"description": "Type of deidentification to apply.",
"format": "enum"
},
"destination": {
"type": "string",
"description": "Target destination of the entity to be stored in vault."
},
"transformation": {
"$ref": "#/components/schemas/Entity_Transformation"
}
},
"description": "Entity detection and deidentification configuration."
},
"Detect_ObjectEntity": {
"type": "object",
"properties": {
"entityType": {
"enum": [
"NONE",
"FACE",
"LICENSE_PLATE",
"LOGO",
"SIGNATURE",
"ALL"
],
"type": "string",
"default": "ALL",
"description": "Type of entity to detect.",
"format": "enum"
},
"deidentificationType": {
"enum": [
"UNKNOWN",
"REDACT",
"UNREDACT"
],
"type": "string",
"default": "UNREDACT",
"description": "Type of deidentification to apply.",
"format": "enum"
}
},
"description": "Object entity detection and deidentification configuration (e.g. faces, license plates)."
},
"DocumentV2": {
"type": "object",
"properties": {
"pdf": {
"$ref": "#/components/schemas/DocumentV2_Pdf"
}
},
"description": "Document detection and deidentification configuration.",
"x-visibility": [
"external"
]
},
"DocumentV2_Pdf": {
"type": "object",
"properties": {
"processingMode": {
"enum": [
"NONE",
"OCR",
"TEXT_LAYER"
],
"type": "string",
"default": "TEXT_LAYER",
"description": "Processing mode of the PDF file.",
"format": "enum"
},
"density": {
"maximum": 1000,
"type": "integer",
"default": 200,
"description": "Pixel density at which to process the PDF file.",
"format": "int32"
},
"maxResolution": {
"maximum": 3000,
"minimum": 72,
"type": "integer",
"default": 3000,
"description": "Max resolution at which to process the PDF file.",
"format": "int32"
}
},
"description": "Advanced options for processing PDF documents.",
"x-visibility": [
"external"
]
},
"Entity_Transformation": {
"type": "object",
"properties": {
"shiftDates": {
"$ref": "#/components/schemas/Transformation_ShiftDates"
}
},
"description": "Optional transformations to apply to detected entity values.",
"x-visibility": [
"external"
]
},
"FileData": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"zip",
"gif"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileMapping": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Location of the source file."
},
"destination": {
"type": "string",
"description": "Location of the target file."
}
},
"description": "Source and destination file paths for a deidentification job."
},
"FileOutput": {
"type": "object",
"properties": {
"processedFile": {
"type": "string",
"description": "Value of the processed file."
},
"processedFileType": {
"enum": [],
"type": "string",
"description": "Type of the processed file.",
"format": "enum"
},
"processedFileExtension": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"zip",
"gif"
],
"type": "string",
"description": "Processed file extension.",
"format": "enum"
}
},
"description": "Represents a single processed output file along with its type and format."
},
"Format": {
"type": "object",
"properties": {
"redacted": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to fully redact."
},
"masked": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to mask."
},
"plaintext": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to return in plaintext."
}
},
"description": "Mapping of preferred data formatting options to entity types. Returned values are dependent on the configuration of the vault storing the data and the permissions of the user or account making the request.",
"x-visibility": [
"external"
]
},
"IdentifyResponse": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Re-identified text."
}
},
"description": "Response after identifying text."
},
"ImageV2": {
"type": "object",
"properties": {
"outputProcessedImage": {
"type": "boolean",
"default": true,
"description": "If `true`, includes processed image in the output."
},
"outputOcrText": {
"type": "boolean",
"default": false,
"description": "If `true`, includes text detected by OCR in the response."
},
"maskingMethod": {
"enum": [
"NONE",
"BLUR",
"BLACKBOX"
],
"type": "string",
"default": "BLACKBOX",
"description": "Method to mask the entities in the image.",
"format": "enum"
}
},
"description": "Image detection and deidentification configuration.",
"x-visibility": [
"external"
]
},
"Locations": {
"type": "object",
"properties": {
"start_index": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the first character of the string in the original text.",
"format": "int32"
},
"end_index": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the last character of the string in the original text.",
"format": "int32"
},
"start_index_processed": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the first character of the string in the processed text.",
"format": "int32"
},
"end_index_processed": {
"maximum": 1000000000,
"type": "integer",
"description": "Index of the last character of the string in the processed text.",
"format": "int32"
}
},
"description": "Locations of an entity in the text.",
"x-visibility": [
"external"
]
},
"Media": {
"type": "object",
"properties": {
"audio": {
"$ref": "#/components/schemas/AudioV2"
},
"document": {
"$ref": "#/components/schemas/DocumentV2"
},
"image": {
"$ref": "#/components/schemas/ImageV2"
}
},
"description": "Media-specific detection and deidentification configuration.",
"x-visibility": [
"external"
]
},
"Metrics": {
"type": "object",
"properties": {
"size": {
"type": "number",
"description": "Size of the input text(KB).",
"format": "float"
},
"wordCount": {
"type": "integer",
"description": "Total number of words processed.",
"format": "int32"
},
"characterCount": {
"type": "integer",
"description": "Total number of characters processed.",
"format": "int32"
},
"slides": {
"type": "integer",
"description": "Total number of slides processed.",
"format": "int32"
},
"pages": {
"type": "integer",
"description": "Total number of pages processed.",
"format": "int32"
},
"duration": {
"type": "number",
"description": "Total duration processed(seconds).",
"format": "float"
}
},
"description": "Performance metrics for the detection and deidentification operation.",
"x-visibility": [
"external"
]
},
"RedactionLevel": {
"type": "object",
"properties": {
"replacePattern": {
"type": "string",
"description": "Redaction method to apply. For PDB vaults: `MASKED`, `REDACTED`, or `PLAINTEXT`. For FlowDB vaults: the name of the redaction pattern configured in the vault (e.g., `Mask1`)."
},
"source": {
"type": "string",
"description": "Identifies the entity to redact. For PDB vaults: entity name in uppercase (e.g., `SSN`, `NAME`). For FlowDB vaults: token group name (e.g., `tokenGroup1`)."
}
},
"description": "Specifies a replacement pattern and the entity types it applies to during reidentification."
},
"ReidentifiedFileOutput": {
"type": "object",
"properties": {
"processed_file": {
"type": "string",
"description": "File content in Base64 format."
},
"processed_file_type": {
"enum": [
"reidentified_file"
],
"type": "string",
"description": "Type of the processed file.",
"format": "enum"
},
"processed_file_extension": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"gif"
],
"type": "string",
"description": "Extension of the processed file.",
"format": "enum"
}
},
"description": "Details of output files. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"ReidentifyFileRequestV2": {
"required": [
"dataSource",
"value",
"vaultId",
"dataFormat"
],
"type": "object",
"properties": {
"dataSource": {
"enum": [
"BASE64",
"SKYFLOW_ID",
"PRESIGNED_URL"
],
"type": "string",
"description": "Data source of the input file. `BASE64`: Base64-encoded file string. `SKYFLOW_ID`: Reference file by vault ID. `PRESIGNED_URL`: S3 presigned URL of input file.",
"format": "enum"
},
"value": {
"type": "string",
"description": "File data corresponding to the specified `dataSource` type."
},
"dataFormat": {
"enum": [
"mp3",
"wav",
"pdf",
"txt",
"csv",
"json",
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"xls",
"xlsx",
"doc",
"docx",
"ppt",
"pptx",
"xml",
"dcm",
"jsonl",
"zip",
"gif"
],
"type": "string",
"description": "Format of the input file.",
"format": "enum"
},
"vaultId": {
"type": "string",
"description": "ID of the vault used for de-identification."
},
"redactionLevel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RedactionLevel"
},
"description": "Replacement patterns applied to entity types during re-identification."
}
},
"description": "Request to reidentify tokens in a file back to their original values.",
"x-visibility": [
"external"
]
},
"ReidentifyFileResponse": {
"type": "object",
"properties": {
"status": {
"enum": [
"UNKNOWN",
"FAILED",
"SUCCESS",
"IN_PROGRESS"
],
"type": "string",
"description": "Status of the operation.",
"format": "enum"
},
"output_type": {
"enum": [
"UNKNOWN",
"BASE64"
],
"type": "string",
"description": "Format of the output file.",
"format": "enum"
},
"output": {
"$ref": "#/components/schemas/ReidentifiedFileOutput"
}
},
"description": "Response to get the status & response of a file re-identification request."
},
"ReidentifyFileResponseV2": {
"type": "object",
"properties": {
"status": {
"enum": [
"UNKNOWN",
"FAILED",
"SUCCESS",
"IN_PROGRESS"
],
"type": "string",
"description": "Status of the reidentification request.",
"format": "enum"
},
"outputType": {
"enum": [
"BASE64",
"SKYFLOW_ID",
"PRESIGNED_URL"
],
"type": "string",
"description": "Data source of the output file. `BASE64`: Base64-encoded file string. `SKYFLOW_ID`: Reference file by vault ID. `PRESIGNED_URL`: S3 presigned URL of input file.",
"format": "enum"
},
"output": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FileOutput"
},
"description": "Details of output files"
},
"metrics": {
"$ref": "#/components/schemas/Metrics"
}
},
"description": "Response containing the status and output of a file reidentification job."
},
"ReidentifyStringRequest": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Text to reidentify."
},
"vault_id": {
"type": "string",
"description": "ID of the vault where the entities are stored."
},
"format": {
"$ref": "#/components/schemas/Format"
}
},
"description": "Request to re-identify string."
},
"ReidentifyStringRequestV2": {
"required": [
"text",
"vaultId"
],
"type": "object",
"properties": {
"vaultId": {
"type": "string",
"description": "ID of the vault used for de-identification."
},
"text": {
"type": "string",
"description": "Text to reidentify."
},
"redactionLevel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RedactionLevel"
},
"description": "Replacement patterns applied to entity types during re-identification."
}
},
"description": "Request to reidentify tokens in a string back to their original values.",
"x-visibility": [
"external"
]
},
"ReidentifyStringResponseV2": {
"type": "object",
"properties": {
"processedText": {
"type": "string",
"description": "Reidentified text."
},
"metrics": {
"$ref": "#/components/schemas/Metrics"
}
},
"description": "Response containing the reidentified string with tokens replaced by original values."
},
"ShiftDates": {
"type": "object",
"properties": {
"min_days": {
"type": "integer",
"description": "Minimum number of days to shift the date by.",
"format": "int32"
},
"max_days": {
"type": "integer",
"description": "Maximum number of days to shift the date by.",
"format": "int32"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"date",
"date_interval",
"dob"
],
"type": "string",
"format": "enum",
"maxLength": 3
},
"description": "Entity types to shift dates for."
}
},
"description": "Shift dates by a specified number of days.",
"x-visibility": [
"external"
]
},
"StringResponseEntities": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Processed text of the entity."
},
"value": {
"type": "string",
"description": "Original text of the entity."
},
"location": {
"$ref": "#/components/schemas/Locations"
},
"entity_type": {
"type": "string",
"description": "Highest-rated label."
},
"entity_scores": {
"type": "object",
"additionalProperties": {
"maximum": 1,
"type": "number"
},
"description": "Labels and their scores."
}
},
"description": "Detected entities for String"
},
"TokenTypeMapping": {
"type": "object",
"properties": {
"vault_token": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with vault tokens."
},
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only",
"vault_token"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"Transformation_ShiftDates": {
"type": "object",
"properties": {
"minDays": {
"type": "integer",
"description": "Minimum number of days to shift dates.",
"format": "int32"
},
"maxDays": {
"type": "integer",
"description": "Maximum number of days to shift dates.",
"format": "int32"
}
},
"description": "Shifts detected date values by a random number of days within the given range.",
"x-visibility": [
"external"
]
},
"Transformations": {
"type": "object",
"properties": {
"shift_dates": {
"$ref": "#/components/schemas/ShiftDates"
}
},
"description": "Transformations to apply to detected entities.",
"x-visibility": [
"external"
]
},
"WordCharacterCount": {
"type": "object",
"properties": {
"wordCount": {
"type": "integer",
"description": "Number of words in the processed text.",
"format": "int32"
},
"characterCount": {
"type": "integer",
"description": "Number of characters in the processed text.",
"format": "int32"
}
},
"description": "Word and character count of the processed text.",
"x-visibility": [
"external"
]
},
"http_code": {
"description": "HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.",
"x-visibility": [
"external"
],
"type": "integer",
"format": "int32",
"minimum": 100,
"maximum": 599
},
"error_response": {
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"grpc_code",
"http_code",
"http_status",
"message"
],
"properties": {
"grpc_code": {
"description": "gRPC status codes. See https://grpc.io/docs/guides/status-codes.",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 16
},
"http_code": {
"$ref": "#/components/schemas/http_code"
},
"http_status": {
"type": "string",
"maxLength": 100
},
"message": {
"type": "string",
"maxLength": 1000
},
"details": {
"type": "array",
"maxItems": 25,
"items": {
"x-visibility": [
"external"
],
"type": "object",
"additionalProperties": true
}
}
}
}
}
},
"FileData_deidentify_audio": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"mp3",
"wav"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_document": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"pdf",
"doc",
"docx"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_image": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"jpg",
"jpeg",
"tif",
"tiff",
"png",
"bmp",
"dcm",
"gif"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_pdf": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"pdf"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_presentation": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"ppt",
"pptx"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_spreadsheet": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"csv",
"xls",
"xlsx"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_structured_text": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"json",
"xml",
"jsonl"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_deidentify_text": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"txt"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"FileData_reidentify_file": {
"required": [
"base64",
"data_format"
],
"type": "object",
"properties": {
"base64": {
"type": "string",
"description": "Base64-encoded data of the file."
},
"data_format": {
"enum": [
"txt",
"csv",
"json",
"xml",
"jsonl"
],
"type": "string",
"description": "Format of the file.",
"format": "enum"
},
"skyflow_id": {
"type": "string",
"description": "Skyflow ID of the record that contains the file to act on."
}
},
"description": "File to process. Files are specified as Base64-encoded data.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_audio": {
"type": "object",
"properties": {
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_document": {
"type": "object",
"properties": {
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_image": {
"type": "object",
"properties": {
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_pdf": {
"type": "object",
"properties": {
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_presentation": {
"type": "object",
"properties": {
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only"
],
"type": "string",
"description": "Default token type to generate for detected entities.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_spreadsheet": {
"type": "object",
"properties": {
"vault_token": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with vault tokens. Only supported for CSV file types."
},
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only",
"vault_token"
],
"type": "string",
"description": "Default token type to generate for detected entities. `vault_token` is only supported for CSV files.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"TokenTypeMapping_deidentify_file": {
"type": "object",
"properties": {
"vault_token": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with vault tokens. Not supported for audio, document, image, presentation, or most spreadsheet file types."
},
"entity_only": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens."
},
"entity_unq_counter": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entity types to replace with entity tokens with unique counters."
},
"default": {
"enum": [
"entity_unq_counter",
"entity_only",
"vault_token"
],
"type": "string",
"description": "Default token type to generate for detected entities. `vault_token` isn't supported for audio, document, image, presentation, or most spreadsheet file types.",
"format": "enum"
}
},
"description": "Mapping of token types to detected entities.",
"x-visibility": [
"external"
]
},
"DeidentifyFileAudioRequest_deidentify_audio": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_audio"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"output_transcription": {
"enum": [
"transcription",
"medical_transcription",
"diarized_transcription",
"medical_diarized_transcription"
],
"type": "string",
"description": "Type of transcription to output.",
"format": "enum"
},
"output_processed_audio": {
"type": "boolean",
"default": true,
"description": "Whether to include the processed audio file in the response."
},
"bleep_start_padding": {
"maximum": 20,
"type": "number",
"default": 0.5,
"description": "Padding added to the beginning of a bleep, in seconds.",
"format": "float"
},
"bleep_stop_padding": {
"maximum": 20,
"type": "number",
"default": 0.2,
"description": "Padding added to the end of a bleep, in seconds.",
"format": "float"
},
"bleep_frequency": {
"maximum": 20000,
"minimum": 20,
"type": "integer",
"default": 600,
"description": "The pitch of the bleep sound, in Hz. The higher the number, the higher the pitch.",
"format": "int32"
},
"bleep_gain": {
"minimum": -60,
"type": "integer",
"default": -3,
"description": "Relative loudness of the bleep in dB. Positive values increase its loudness, and negative values decrease it.",
"format": "int32"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_audio"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a audio file."
},
"DeidentifyFileRequest_deidentify_document": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_document"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_document"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
},
"DeidentifyFileImageRequest_deidentify_image": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_image"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"output_processed_image": {
"type": "boolean",
"description": "If `true`, includes processed image in the output."
},
"output_ocr_text": {
"type": "boolean",
"description": "If `true`, includes text detected by OCR in the response."
},
"masking_method": {
"enum": [
"blur",
"blackbox"
],
"type": "string",
"description": "Method to mask the entities in the image.",
"format": "enum"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_image"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a image file."
},
"DeidentifyFileDocumentPdfRequest_deidentify_pdf": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_pdf"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"density": {
"maximum": 1000,
"type": "integer",
"default": 200,
"description": "Pixel density at which to process the PDF file.",
"format": "int32"
},
"max_resolution": {
"maximum": 3000,
"minimum": 72,
"type": "integer",
"default": 3000,
"description": "Max resolution at which to process the PDF file.",
"format": "int32"
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_pdf"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a pdf file."
},
"DeidentifyFileRequest_deidentify_presentation": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_presentation"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_presentation"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
},
"DeidentifyFileRequest_deidentify_spreadsheet": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_spreadsheet"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_spreadsheet"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
},
"DeidentifyFileRequest_deidentify_structured_text": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_structured_text"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
},
"DeidentifyFileRequest_deidentify_text": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_deidentify_text"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
},
"ReidentifyFileRequest_reidentify_file": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData_reidentify_file"
},
"vault_id": {
"type": "string",
"description": "ID of the vault where the entities are stored."
},
"format": {
"$ref": "#/components/schemas/Format"
}
},
"description": "Request to re-identify file."
},
"DeidentifyFileRequest_deidentify_file": {
"required": [
"file",
"vault_id"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/FileData"
},
"vault_id": {
"type": "string",
"description": "ID of a vault that you have Detect Invoker or Vault Owner permissions for."
},
"entity_types": {
"type": "array",
"items": {
"enum": [
"age",
"bank_account",
"credit_card",
"credit_card_expiration",
"cvv",
"date",
"date_interval",
"dob",
"driver_license",
"email_address",
"healthcare_number",
"ip_address",
"location",
"name",
"numerical_pii",
"phone_number",
"ssn",
"url",
"vehicle_id",
"medical_code",
"name_family",
"name_given",
"account_number",
"event",
"filename",
"gender",
"language",
"location_address",
"location_city",
"location_coordinate",
"location_country",
"location_state",
"location_zip",
"marital_status",
"money",
"name_medical_professional",
"occupation",
"organization",
"organization_medical_facility",
"origin",
"passport_number",
"password",
"physical_attribute",
"political_affiliation",
"religion",
"time",
"username",
"zodiac_sign",
"blood_type",
"condition",
"dose",
"drug",
"injury",
"medical_process",
"statistics",
"routing_number",
"corporate_action",
"financial_metric",
"product",
"trend",
"duration",
"location_address_street",
"all",
"sexuality",
"effect",
"project",
"organization_id",
"day",
"month",
"year"
],
"type": "string",
"format": "enum",
"maxLength": 70
},
"description": "Entities to detect and de-identify."
},
"token_type": {
"$ref": "#/components/schemas/TokenTypeMapping_deidentify_file"
},
"allow_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to display in plaintext. Entities appear in plaintext if an expression matches either the entirety of a detected entity or a substring of it. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext."
},
"restrict_regex": {
"type": "array",
"items": {
"type": "string"
},
"description": "Regular expressions to replace with '[RESTRICTED]'. Expressions must match the entirety of a detected entity, not just a substring, for the entity to be restricted. Expressions don't match across entity boundaries. If a string or entity matches both `allow_regex` and `restrict_regex`, the entity is displayed in plaintext. If a string is detected as an entity and a `restrict_regex` pattern matches the entire detected entity, the entity is replaced with '[RESTRICTED]'. If a string is detected as an entity but a `restrict_regex` pattern only matches a substring of it, the `restrict_regex` pattern is ignored, and the entity is processed according to the specified tokenization and transformation settings. Note: Vault tokens are currently not supported."
},
"transformations": {
"$ref": "#/components/schemas/Transformations"
},
"configuration_id": {
"type": "string",
"description": "ID of the Detect configuration to use for de-identification. Can't be specified with fields other than `vault_id`, `text`, and `file`."
}
},
"description": "Request to deidentify a file."
}
},
"securitySchemes": {
"Bearer": {
"type": "http",
"description": "Access token, prefixed by `Bearer `.",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"headers": {
"x-request-id": {
"description": "Unique identifier for the request.",
"schema": {
"type": "string",
"minLength": 36,
"maxLength": 36
},
"example": "d4410ea0-1d83-473c-a09a-24c6b03096d4"
}
},
"examples": {
"400_response": {
"value": {
"error": {
"grpc_code": 3,
"http_code": 400,
"http_status": "Bad Request",
"message": "The request was invalid or cannot be served. Check the request parameters and try again.",
"details": []
}
}
},
"401_response": {
"value": {
"error": {
"grpc_code": 16,
"http_code": 401,
"http_status": "Unauthorized",
"message": "The request is unauthorized. Make sure you have a valid access token.",
"details": []
}
}
},
"500_response": {
"value": {
"error": {
"grpc_code": 13,
"http_code": 500,
"http_status": "Internal Server Error",
"message": "Skyflow services experienced an internal error. Contact Skyflow support with request ID d4410ea0-1d83-473c-a09a-24c6b03096d4 for more information.",
"details": []
}
}
}
},
"responses": {
"400": {
"description": "Returned when the request is invalid or cannot be served.",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error_response"
},
"examples": {
"Bad request": {
"$ref": "#/components/examples/400_response"
}
}
}
}
},
"401": {
"description": "Returned when the request is unauthorized.",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error_response"
},
"examples": {
"Unauthorized": {
"$ref": "#/components/examples/401_response"
}
}
}
}
},
"500": {
"description": "An unexpected error response.",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/x-request-id"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error_response"
},
"examples": {
"Internal server error": {
"$ref": "#/components/examples/500_response"
}
}
}
}
}
}
}
}