Skip to Content
Valdra Help
Shielk

Use the Shielk API

Create a Shielk API key, hide people's details in a text with one call, and replace the key when you need to.

Read the video as text

Shielk API quickstart, in Shielk.

The clinic in this video is made up, and so is every detail.

Your API key is on the Account page. Only a short preview is shown; the full key is shown once, when you create it.

Send the key in the X API Key header of each request.

The developer portal shows a first request, the answer you get back, the error codes and the rate limits.

Need a new key? Regenerate it from the portal, then update it wherever you use it.

What this is for

Your own app or script can send text to Shielk and get it back with people's details hidden. You need an API key for that. This page shows how to make the key, make your first call and replace the key.

This is general guidance, not legal advice.

Before you start

  • Plan: Pro, Agency or Enterprise. Pro has 10,000 API calls a month, Agency 50,000 and Enterprise 250,000. Free has no API key.
  • Role: you, signed in to the Shielk web app. A key cannot make another key.
  • Have ready: a terminal or a tool that sends web requests.

Steps

Click Generate API key

Open your Account page. In the card API access, click Generate API key.

You will see the full key once, with Copy this key now. It is shown only once. Click Copy and keep the key somewhere safe.

The Account page with the API access card.
The Account page with the API access card.

Send your first call

Send the text to the anonymize endpoint. Put your key in the X-API-Key header. The key below is a fake placeholder.

curl -X POST https://app.shielk.com/api/v1/anonymize \
  -H "Content-Type: application/json" \
  -H "X-API-Key: csk_YOUR_KEY_HERE" \
  -d '{"text": "Alex Exemple, SIN 046-454-286", "language": "en"}'

Only text is required. language can be auto, en or fr. You can also send jurisdiction, a province code such as QC, and industry.

Read the answer

The answer is JSON. anonymized_text is your text with codes. reverse_mapping gives each code with its real value, so your app can put the values back. usage shows your calls this month.

{
  "status": "success",
  "data": {
    "anonymized_text": "<PERSON_1>, SIN <CA_SIN_1>",
    "entity_count": 2,
    "entities_found": [
      { "entity_type": "PERSON", "start": 0, "end": 12, "token": "<PERSON_1>" },
      { "entity_type": "CA_SIN", "start": 18, "end": 29, "token": "<CA_SIN_1>" }
    ],
    "detected_language": "en",
    "reverse_mapping": { "<PERSON_1>": "Alex Exemple", "<CA_SIN_1>": "046-454-286" }
  },
  "usage": { "jobs_used": 1, "jobs_limit": 10000, "jobs_remaining": 9999, "tier": "pro" },
  "disclaimer": "This analysis is generated by automated detection and is provided for informational purposes only."
}

This example is shortened and built from the fields the code returns. The real answer has more fields, and its values depend on your text.

Replace the key

On the Account page, click Make a new key. You will see Your current key stops working at once. Confirm. Copy the new key and put it in your app.

There is no button that turns off the API key without making a new one. To stop the current key, make a new one. The old key stops working at once.

What you will see

After you leave the page, the API access card shows Preview only. The full key is shown once when you create it. and a short preview of the key. You cannot copy the full key again.

The Developer Portal shows your Monthly limit, the Key name and how to Use in header.

The Developer Portal with the API key and its monthly limit.
The Developer Portal with the API key and its monthly limit.

Your API key is separate from your browser extension key. For the extension, use the card Browser extension key.

Common mistakes and fixes

You see API access requires Pro plan or above. You are on Free. Upgrade to get a key.

You lost the key. You cannot see it again. Click Make a new key, then update your app.

You used your extension key in your app. It works only with the extension. Make an API key.

The text is long. Send up to 50,000 characters in one call.

If it did not work

Invalid API key. Check your X-API-Key header. The key is wrong or was replaced. Copy the current key.

No text provided. Send a text field that is not empty.

The request body must be a JSON object, for example {"text": "your text here"}. Send one JSON object, not a list or a string.

Text too long. Maximum 50,000 characters The text is over the limit. Split it.

API key monthly limit reached You used this month's calls. Upgrade, or wait for next month.

API keys require a Pro subscription or higher. Upgrade at shielk.com/pricing Your account is on Free.

This key works only with the Shielk browser extension. You sent the extension key. Use the API key.

Could not generate API key. Click Generate API key again.

Next step

Hide details in a document or text.

On this page