Skip to content

docs: fix API key mismatch in documentation and raw guardrail JSON#832

Merged
vrushankportkey merged 1 commit intomainfrom
docs/guardrails-raw
Apr 1, 2026
Merged

docs: fix API key mismatch in documentation and raw guardrail JSON#832
vrushankportkey merged 1 commit intomainfrom
docs/guardrails-raw

Conversation

@harshitkumar454
Copy link
Copy Markdown

@harshitkumar454 harshitkumar454 commented Apr 1, 2026

Fix: Incorrect key for regex pattern in documentation

Summary

This PR fixes an incorrect key used for passing regex patterns in the documentation.

Issue

While following the documentation, I used the regex key to pass a regex pattern. However, this did not work as expected.

Root Cause

After testing with the Python SDK and verifying with the backend, it was confirmed that:

  • The correct key to use is rule
  • The documented key regex is incorrect

Fix

  • Updated the documentation to replace regex with rule for regex pattern usage

Validation

  • Verified the behavior using the Python SDK
  • Confirmed correctness with backend implementation

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
portkey-docs 🟢 Ready View Preview Apr 1, 2026, 10:29 AM

@vrushankportkey vrushankportkey merged commit 804f8aa into main Apr 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants