Skip to content

docs: add Alice guardrail page - #1095

Draft
itsthusharashenoi wants to merge 1 commit into
mainfrom
feat/alice-guardrail-docs
Draft

itsthusharashenoi wants to merge 1 commit into
mainfrom
feat/alice-guardrail-docs

Conversation

@itsthusharashenoi

Copy link
Copy Markdown
Contributor

What

Documents alice.evaluate, the Alice guardrail plugin added in the companion gateway PR.

Files changed:

  • integrations/guardrails/alice.mdx — full Alice guardrail page
  • aigw/integrations/guardrails/alice.mdx — mirror for the AIGW product view
  • docs.json — nav entry added in both the integrations/guardrails and aigw/integrations/guardrails sections (after akto)
  • product/guardrails/list-of-guardrail-checks.mdx — Alice card added to the partner guardrails list

Why

Companion to the enterprise gateway integration. Alice customers need documentation to configure and use the guardrail.

Related links:

The page covers:

  • Credentials setup and adding the check
  • Naming the application — why appId is a check parameter (not a credential), and why it is not read from x-portkey-metadata
  • What is sent — the context forwarding behaviour and credential-stripping rules
  • Verdict table — ALLOW / BLOCK / MASK / DETECT and the all-or-nothing MASK behaviour
  • When Alice cannot be reached — all failures report as check errors; failOnError explanation
  • Streaming caveat (blocking works, masking does not on streamed responses)

Follows the same structure as the recent CrowdStrike AIDR and F5 pages.

⚠️ Keep as draft — endpoint not yet public

The /v2/evaluate/portkey Alice endpoint this guardrail calls is not publicly live yet (Alice are deploying it — see issue #1792). This docs PR should remain a draft alongside the gateway PR and both should be marked ready together once Alice coint is reachable.

Test plan

  • mint dev — page renders correctly, no broken links on the new page
  • Nav entry appears under Integrations → Guardrails → Alice
  • Alice card appears in the partner guardrails list
  • Once gateway PR is merged and endpoint is live, verify the config + request samples work end-to-end

Co-authored-by: Cursor <cursoragent@cursor.com>
@mintlify

mintlify Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
portkey-docs 🟢 Ready View Preview Sep 24, 2026, 6:29 AM

This branch was successfully deployed

1 active deployment
staging — 92bb7576 Deployed Sep 24, 2026 by mintlify[bot]
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.

1 participant