Sign in
guardrails

Apply Guardrail

Apply a guardrail to text input and return the processed result.

This endpoint allows testing guardrails by applying them to custom text inputs.

post/guardrails/apply_guardrail

Request body

entitiesPiiEntityType[] nullable
guardrail_namestring required
input_typestring
languagestring nullable
messagesobject[] nullable
metadataobject nullable
textstring required

Response

Successful Response

response_textstring required

Changes

Changed in 12 of the 42 revisions of this API.18

  • b694deb1e4591See the full diff
    • ○

      api tag guardrails added

      api-tag-added

  • cfac079bcc041See the full diff
    • ○

      api tag guardrails removed

      api-tag-removed

  • a4fccd4bf54d1See the full diff
    • ○

      api tag guardrails added

      api-tag-added

  • 6246f8d427b71See the full diff
    • ○

      api tag guardrails removed

      api-tag-removed

  • c357baf422ab1See the full diff
    • ○

      api tag guardrails added

      api-tag-added

  • 082b5fabd9097See the full diff
    • ○

      api tag guardrails removed

      api-tag-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new UK_PASSPORT enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new UK_POSTCODE enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new UK_VEHICLE_REGISTRATION enum value to the request property //

      request-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e2f308355e2d1See the full diff
    • ○

      api tag guardrails added

      api-tag-added

  • 89805a9f84ad1See the full diff
    • ○

      api tag guardrails removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5c00a227eebf1See the full diff
    • ○

      api tag guardrails added

      api-tag-added

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 24ad9eaf6a001See the full diff
    • ○

      api tag guardrails removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog