# Nyraxis documentation

Practical SDK, API, policy, testing and deployment documentation. Python SDK 1.3.2; Node SDK 1.2.9.

A completed check, measured detector accuracy, and application enforcement are separate requirements. Recipes are not a certification of every provider or framework. See the support matrix for live verification scope.

## About Nyraxis

Nyraxis helps teams monitor connected AI agent activity, evaluate policies, investigate findings, export review evidence, and retest changes.

- **AI agent red teaming**: Run selected adversarial probes against an authorized agent endpoint and inspect completed, failed, and incomplete outcomes. [Documentation](https://nyraxis.io/docs/guides/agent-testing)
- **Policy evaluation**: Evaluate text against configured checks. The application must handle completion, failure behavior, and the returned decision. [Documentation](https://nyraxis.io/docs/guides/policies)
- **Agent traces**: Inspect recorded spans and policy findings. Uninstrumented operations are outside the recorded evidence. [Documentation](https://nyraxis.io/docs/guides/traces-and-findings)
- **Regression tests and CI**: Save a specific assertion, run it against a connected agent after a change, and distinguish passed, failed, and incomplete results. [Documentation](https://nyraxis.io/docs/guides/regressions)
- **Safeguard templates**: Configure safeguard bundles for GDPR, the EU AI Act, HIPAA and SOC 2 reviews. Templates support selected technical checks and do not establish compliance or certification. [Documentation](https://nyraxis.io/docs/compliance)
- **Evidence reports**: Export PDF or CSV evidence of configured policies, recorded findings and selected audit activity. Coverage depends on recorded activity and completed checks. [Documentation](https://nyraxis.io/docs/guides/reports-and-audit)

## Scope and evidence

- Configured policy checks and passing examples do not prove general safety or compliance.
- Detector availability and integration coverage depend on the deployment and supported operations.
- Metadata-only storage does not mean evaluation text stays in the application; review processing destinations.
- The homepage examples are synthetic illustrations, not live scan results or accuracy benchmarks.

## Product resources

- [Product and hosted pricing](https://nyraxis.io/): Who Nyraxis is for, product capabilities, hosted pricing, and deployment options.
- [Quickstart](https://nyraxis.io/docs/quickstart): Connect the Python or Node client and inspect one policy decision.
- [Verified integration scope](https://nyraxis.io/docs/support-matrix): Supported operations, tested versions, and remaining integration limits.
- [Data handling](https://nyraxis.io/docs/guides/data-handling): Processing destinations, capture settings, and retention boundaries.
- [Private deployment](https://nyraxis.io/docs/guides/enterprise): Installation-specific identity, storage, model endpoints, and operating responsibilities.
- [Sample red-team report](https://nyraxis.io/sample-redteam-report.pdf): A downloadable example of scoped assessment evidence.
- [Engineering articles](https://nyraxis.io/blog): Practical guides to agent security testing, governance, and audit evidence.
- [Book a demo](https://nyraxis.io/demo): Review a synthetic workflow and discuss a scoped integration.
- [Trust center](https://nyraxis.io/trust): Privacy, security, provider integrations and processing requirements.
- [Privacy choices](https://nyraxis.io/cookies): Control optional analytics and review browser storage.
- [Legal documents](https://nyraxis.io/legal): Separate terms, privacy, cookies, acceptable use, cancellation and processing documents.

## Pages

- [Evaluation API](https://nyraxis.io/docs/api-reference): Authenticate a request, submit text, and interpret the decision and completion diagnostics.
- [Policy templates and compliance scope](https://nyraxis.io/docs/compliance): Reviewed safeguard bundles, required setup, and the evidence they can support.
- [Core concepts](https://nyraxis.io/docs/concepts): Understand agents, policies, decisions, traces, and the limits of enforcement.
- [Test a connected agent](https://nyraxis.io/docs/guides/agent-testing): Configure an HTTP target, run a bounded assessment, and inspect the evidence.
- [API keys and access](https://nyraxis.io/docs/guides/api-keys): Create the right key for evaluation, telemetry, or CI without exposing credentials.
- [Enforcement](https://nyraxis.io/docs/guides/auto-enforce): Choose failure behavior and understand exactly where an SDK check can stop a call.
- [Local SDK rehearsal](https://nyraxis.io/docs/guides/candidate-pilot): Run the repository’s synthetic SDK lifecycle rehearsal without treating it as a live-model benchmark.
- [Policies and compliance evidence](https://nyraxis.io/docs/guides/compliance): Use scoped policy results as evidence for your team's review.
- [Workspace and agents](https://nyraxis.io/docs/guides/dashboard): Create an organization, register an agent, and follow its activity through the dashboard.
- [Data handling](https://nyraxis.io/docs/guides/data-handling): Understand evaluation destinations, telemetry content, capture settings, and retained evidence.
- [Self-hosted operations](https://nyraxis.io/docs/guides/enterprise): Agree hosting, access, processing destinations, operating responsibilities and acceptance for a private deployment.
- [Build and operate](https://nyraxis.io/docs/guides): Take an agent from its first key to repeatable tests and operational evidence.
- [Playground evaluation](https://nyraxis.io/docs/guides/playground): Inspect a direct policy decision before connecting a complete agent.
- [Configure policies](https://nyraxis.io/docs/guides/policies): Choose a detector, scope it to an agent, and verify warning and blocking behavior.
- [Regressions and CI](https://nyraxis.io/docs/guides/regressions): Save a finding as a repeatable check and keep failed or incomplete runs out of a release gate.
- [Reports and audit evidence](https://nyraxis.io/docs/guides/reports-and-audit): Export a defined scope and explain exactly what the records demonstrate.
- [Traces and findings](https://nyraxis.io/docs/guides/traces-and-findings): Inspect recorded execution, distinguish completion from safety, and triage a violation.
- [Troubleshooting](https://nyraxis.io/docs/guides/troubleshooting): Diagnose access errors, incomplete evaluations, missing traces, and slow loading.
- [Settings, alerts and retention](https://nyraxis.io/docs/guides/workspace-settings): Understand account, organization and platform configuration boundaries.
- [Build security into your agent](https://nyraxis.io/docs): Connect your application, evaluate a policy, and turn findings into repeatable tests.
- [Anthropic](https://nyraxis.io/docs/integrations/anthropic): Evaluate input before Anthropic runs and buffer output for a second decision.
- [AutoGen](https://nyraxis.io/docs/integrations/autogen): Evaluate input before AutoGen runs and buffer output for a second decision.
- [AWS Bedrock](https://nyraxis.io/docs/integrations/aws-bedrock): Evaluate input before AWS Bedrock runs and buffer output for a second decision.
- [Azure OpenAI](https://nyraxis.io/docs/integrations/azure-openai): Evaluate input before Azure OpenAI runs and buffer output for a second decision.
- [Cohere](https://nyraxis.io/docs/integrations/cohere): Evaluate input before Cohere runs and buffer output for a second decision.
- [CrewAI](https://nyraxis.io/docs/integrations/crewai): Evaluate input before CrewAI runs and buffer output for a second decision.
- [Django](https://nyraxis.io/docs/integrations/django): Gate an application-owned request and buffered model response in Django.
- [DSPy](https://nyraxis.io/docs/integrations/dspy): Evaluate input before DSPy runs and buffer output for a second decision.
- [Express](https://nyraxis.io/docs/integrations/express): Validate a server request, evaluate input, and gate a buffered OpenAI response.
- [Fireworks AI](https://nyraxis.io/docs/integrations/fireworks): Put an explicit Nyraxis text gate around an OpenAI-compatible Fireworks AI call.
- [Flask](https://nyraxis.io/docs/integrations/flask): Gate an application-owned request and buffered model response in Flask.
- [Google Gemini](https://nyraxis.io/docs/integrations/google-gemini): Evaluate input before Google Gemini runs and buffer output for a second decision.
- [Groq](https://nyraxis.io/docs/integrations/groq): Put an explicit Nyraxis text gate around an OpenAI-compatible Groq call.
- [Haystack](https://nyraxis.io/docs/integrations/haystack): Evaluate input before Haystack runs and buffer output for a second decision.
- [Integration recipes](https://nyraxis.io/docs/integrations): Connect your provider or framework at an explicit application boundary.
- [LangChain](https://nyraxis.io/docs/integrations/langchain): Evaluate input before LangChain runs and buffer output for a second decision.
- [LangGraph agent journey](https://nyraxis.io/docs/integrations/langgraph): Run a real model, a read-only tool, input enforcement and explicit output gates.
- [LlamaIndex](https://nyraxis.io/docs/integrations/llamaindex): Evaluate input before LlamaIndex runs and buffer output for a second decision.
- [Mistral AI](https://nyraxis.io/docs/integrations/mistral): Evaluate input before Mistral AI runs and buffer output for a second decision.
- [Ollama](https://nyraxis.io/docs/integrations/ollama): Evaluate input before Ollama runs and buffer output for a second decision.
- [OpenAI](https://nyraxis.io/docs/integrations/openai): Evaluate input before OpenAI runs and buffer output for a second decision.
- [Replicate](https://nyraxis.io/docs/integrations/replicate): Evaluate input before Replicate runs and buffer output for a second decision.
- [Semantic Kernel](https://nyraxis.io/docs/integrations/semantic-kernel): Evaluate input before Semantic Kernel runs and buffer output for a second decision.
- [Together AI](https://nyraxis.io/docs/integrations/together-ai): Put an explicit Nyraxis text gate around an OpenAI-compatible Together AI call.
- [Vercel AI SDK](https://nyraxis.io/docs/integrations/vercel-ai): Use an explicit server-side gate around a buffered AI SDK generation.
- [Docs for AI assistants](https://nyraxis.io/docs/mcp): Read the same public documentation through MCP or generated text files.
- [Bias signals](https://nyraxis.io/docs/providers/bias-detection): Configuration, evaluation scope, and practical limits for bias_detection.
- [Competitor mentions](https://nyraxis.io/docs/providers/competitor-mention): Configuration, evaluation scope, and practical limits for competitor_check.
- [Gibberish heuristics](https://nyraxis.io/docs/providers/gibberish-detection): Configuration, evaluation scope, and practical limits for gibberish_detection.
- [Grounded output](https://nyraxis.io/docs/providers/hallucination): Configuration, evaluation scope, and practical limits for hallucination.
- [Policy providers](https://nyraxis.io/docs/providers): Choose a check, configure its scope, and verify its actual coverage.
- [Jailbreak attempts](https://nyraxis.io/docs/providers/jailbreak): Configuration, evaluation scope, and practical limits for jailbreak.
- [NSFW text](https://nyraxis.io/docs/providers/nsfw-detection): Configuration, evaluation scope, and practical limits for nsfw_detection.
- [Personal data (PII)](https://nyraxis.io/docs/providers/pii-detection): Configuration, evaluation scope, and practical limits for pii_detection.
- [Prompt injection](https://nyraxis.io/docs/providers/prompt-injection): Configuration, evaluation scope, and practical limits for prompt_injection.
- [Secrets detection](https://nyraxis.io/docs/providers/secrets-detection): Configuration, evaluation scope, and practical limits for secrets_detection.
- [Sensitive topics](https://nyraxis.io/docs/providers/sensitive-topics): Configuration, evaluation scope, and practical limits for sensitive_topics.
- [SQL injection patterns](https://nyraxis.io/docs/providers/sql-injection): Configuration, evaluation scope, and practical limits for sql_injection.
- [Tool authorization](https://nyraxis.io/docs/providers/tool-authorization): Configuration, evaluation scope, and practical limits for tool_authorization.
- [Topic restrictions](https://nyraxis.io/docs/providers/topic-restriction): Configuration, evaluation scope, and practical limits for topic_restriction.
- [Toxicity](https://nyraxis.io/docs/providers/toxicity): Configuration, evaluation scope, and practical limits for toxicity.
- [Unusual prompt patterns](https://nyraxis.io/docs/providers/unusual-prompt): Configuration, evaluation scope, and practical limits for unusual_prompt.
- [Unsafe web content](https://nyraxis.io/docs/providers/web-sanitization): Configuration, evaluation scope, and practical limits for web_sanitization.
- [Quickstart](https://nyraxis.io/docs/quickstart): Connect a client, evaluate synthetic text, and inspect the result.
- [SDKs and tracing](https://nyraxis.io/docs/sdk): Select the Python or Node client and verify the boundary you need.
- [Node.js SDK](https://nyraxis.io/docs/sdk/node): Evaluate content and wrap supported OpenAI methods with @nyraxis/sdk 1.2.9.
- [Python SDK](https://nyraxis.io/docs/sdk/python): Configure evaluation, input enforcement, tracing, and lifecycle in nyraxis-sdk 1.3.2.
- [Tracing and lifecycle](https://nyraxis.io/docs/sdk/tracing): Group an interaction, control content capture, and verify that spans reach Nyraxis.
- [Integration coverage](https://nyraxis.io/docs/support-matrix): Choose an integration by its verified behavior, package version, and remaining limits.

## Machine-readable content

- [Product facts](https://nyraxis.io/product-facts.json)
- [Full documentation](https://nyraxis.io/llms-full.txt)
- [Documentation MCP](https://nyraxis.io/docs/mcp)