Skip to main content

Multilingual Packs

GET/v1/orgs/{org_id}/multilingual/{language}/custom

Get Custom Keywords

Get custom (user-added) keywords for a language pack.

Bearer token or X-API-Keyscope: org memberoperation_id: multilingual.getCustom

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/multilingual/<language>/custom" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

{
  "language": "string",
  "jailbreak_keywords": [
    "string"
  ],
  "toxicity_keywords": [
    "string"
  ],
  "pii_patterns": {}
}

Schema: object

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-
language#pathstringrequired-

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional-
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

languagerequiredstring
jailbreak_keywordsstring[]
toxicity_keywordsstring[]
pii_patternsobject

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have org access (wrong org_id, or insufficient role).-
404Resource does not exist in this org.-