Create Guardrail

Create a new guardrail row.

Slug is derived from name and made unique with numeric suffixes on collision. Empty post normalization slug returns 422.

POST /admin/api/v1/guardrails

Create Guardrail

cURL

curl --request POST \
  --url https://api.example.com/admin/api/v1/guardrails \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "guardrail": {
    "banned_words": [
      "<string>"
    ],
    "config_id": "ban_list",
    "api_key": "",
    "reject_message": ""
  },
  "enabled": true,
  "sortOrder": 0
}
'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "enabled": true,
    "sortOrder": 1,
    "guardrail": {
      "banned_words": [
        "<string>"
      ],
      "config_id": "ban_list",
      "api_key": "",
      "reject_message": ""
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "reload": {
    "message": "<string>",
    "error": "<string>"
  }
}

Body

application/json

Body for POST /admin/api/v1/guardrails.

name · string · required

position · enum<string> · required

Available options: input, output

guardrail · SimpleBanListConfig · object · required

SimpleBanListConfig

SimplePIIConfig

SimpleNSFWTextConfig

SimpleToxicLanguageConfig

SimpleGibberishTextConfig

SimpleBiasCheckConfig

SimpleCompetitionCheckConfig

SimpleCorrectLanguageConfig

SimpleRestrictToTopicConfig

Show child attributes

enabled · boolean · default: true

sortOrder · integer · default: 0

Required range: x >= 0

Response

201

application/json

Successful Response

data · StandaloneGuardrailRead · object · required

GET response and the data payload of POST/PATCH/DELETE responses.

Show child attributes

reload · StandaloneReloadResult · object · required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Show child attributes