# SecureAI

- [Bienvenido a SecureAI](https://docs.hiperai.com/intro.md): Plataforma empresarial de Inteligencia Artificial segura, conforme a normativas y con control total de gobernanza.
- [Guía de Inicio Rápido (Quickstart)](https://docs.hiperai.com/quickstart.md): Comienza a utilizar SecureAI en minutos: acceso a la plataforma, configuración del asistente y creación de tu primer índice RAG.
- [Models](https://docs.hiperai.com/models/index.md)
- [Document Processing](https://docs.hiperai.com/chat/document-processing.md)
- [Knowledge Bases & RAG](https://docs.hiperai.com/indexes/overview.md)
- [Security Overview](https://docs.hiperai.com/security/overview.md)
- [SMLTP Security](https://docs.hiperai.com/security/smltp.md)
- [Threat Defense](https://docs.hiperai.com/threat-defense/overview.md)
- [Data Protection (DLP & PII)](https://docs.hiperai.com/data-protection/overview.md)
- [Immutable Logs](https://docs.hiperai.com/security/immutable-logs.md)
- [AI Gateway Overview](https://docs.hiperai.com/ai-gateway/overview.md)
- [Remote Endpoints](https://docs.hiperai.com/ai-gateway/remote-endpoints.md)
- [User & Access Management](https://docs.hiperai.com/users/overview.md)
- [Google Workspace (SSO)](https://docs.hiperai.com/iam/google-workspace.md)
- [Microsoft Entra ID (SSO)](https://docs.hiperai.com/iam/microsoft-entra-id.md)
- [Basic Auth](https://docs.hiperai.com/iam/basic-auth.md)
- [AI Discovery & Inventory Overview](https://docs.hiperai.com/discovery/overview.md): How SecureAI discovers and inventories every AI agent, model, identity, and shadow-AI source across your organization
- [Cloud Sensors](https://docs.hiperai.com/discovery/cloud-sensors.md): The read-only inventory of agents and models discovered inside your connected AI cloud platforms
- [Network Sources](https://docs.hiperai.com/discovery/network-sources.md): Shadow-AI discovery — which corporate source IPs and users are calling LLM APIs, from your CASB/SWG logs
- [NHI Inventory](https://docs.hiperai.com/discovery/nhi-inventory.md): Inventory and govern the Non-Human Identities — API keys and service accounts — behind your AI agents and workloads
- [Agent Registry](https://docs.hiperai.com/discovery/agent-registry.md): Govern your logical AI agents and chatbots — owners, purpose, autonomy level, risk, and bindings
- [Endpoint Agent Overview](https://docs.hiperai.com/agent/overview.md): The SecureAI OS Agent — endpoint AI governance, DLP, and egress control for laptops and servers
- [Installing the Agent](https://docs.hiperai.com/agent/installation.md): Install the SecureAI OS Agent on Windows, Linux, and macOS endpoints
- [Enrollment & Installer Packages](https://docs.hiperai.com/agent/enrollment-and-packages.md): How SecureAI OS Agent installer packages, enrollment keys, and device tokens work
- [Policies & Groups](https://docs.hiperai.com/agent/policies-and-groups.md): Configure what the SecureAI OS Agent enforces with policies, groups, protection presets, and safe rollouts
- [Egress Enforcement](https://docs.hiperai.com/agent/egress-enforcement.md): Control or block outbound AI traffic from endpoints with the SecureAI OS Agent
- [Quarantine & Fleet Ops](https://docs.hiperai.com/agent/quarantine-and-fleet-ops.md): Respond to endpoint threats — quarantine, restore, isolate, incidents, and fleet-wide operations
- [Transparent Proxy (AI Routing)](https://docs.hiperai.com/agent/transparent-proxy.md): Route developer AI traffic (e.g. Claude Code) through the SecureAI gateway from the endpoint
- [Claude Code](https://docs.hiperai.com/integrations/ide-claude-code.md): Use Claude Code with SecureAI — full SMLTP, DLP, and PII enforcement for AI-assisted development
- [Cloud AI Providers Overview](https://docs.hiperai.com/integrations/cloud/overview.md): Connect your OpenAI, Anthropic, Azure, AWS, and GCP AI platforms so SecureAI can inventory agents, models, identities, usage, and cost
- [OpenAI Platform](https://docs.hiperai.com/integrations/cloud/openai-platform.md): Connect the OpenAI Platform so SecureAI can inventory projects, models, keys, usage, and cost
- [Anthropic Console](https://docs.hiperai.com/integrations/cloud/anthropic-console.md): Connect the Anthropic Console so SecureAI can inventory workspaces, keys, usage, cost, and audit activity
- [Azure AI Foundry](https://docs.hiperai.com/integrations/cloud/azure-ai-foundry.md): Connect Azure AI Foundry / Azure OpenAI so SecureAI can inventory agents, models, identities, RBAC, usage, and cost
- [Google Vertex AI](https://docs.hiperai.com/integrations/cloud/gcp-vertex-ai.md): Connect Google Vertex AI so SecureAI can inventory agents, models, service accounts, IAM, usage, and cost
- [Splunk Security Integration](https://docs.hiperai.com/integrations/splunk-security.md): Integration Guide: Connecting Splunk SIEM with HiperAI via HTTP Event Collector (HEC)
- [Microsoft Sentinel Integration](https://docs.hiperai.com/integrations/microsoft-sentinel.md): Integration Guide: Connecting Microsoft Sentinel with HiperAI via Azure Data Collection Rules (DCR)
- [Elastic Security Integration](https://docs.hiperai.com/integrations/elastic-security.md): Integrate HiperAI with Elastic Security for advanced threat detection and security analytics
- [Custom SIEM / Webhook Integration](https://docs.hiperai.com/integrations/custom-siem-webhook.md): Generic SIEM (HTTP/Webhook) integration for sending SecureAI security logs to any custom HTTP endpoint
- [CASB & Network (SWG) Overview](https://docs.hiperai.com/integrations/casb/overview.md): Discover shadow AI from your CASB / SWG / DNS logs — which corporate sources are calling LLM APIs, with no agent required
- [Cisco Umbrella](https://docs.hiperai.com/integrations/casb/cisco-umbrella.md): Detect shadow AI from Cisco Umbrella DNS activity via the Reporting API v2
- [MCP Connectors Overview](https://docs.hiperai.com/integrations/mcp/overview.md): Connect Model Context Protocol (MCP) servers to give SecureAI's assistants governed access to tools
- [Remote MCP with OAuth & DCR](https://docs.hiperai.com/integrations/mcp/remote-oauth-dcr.md): How SecureAI connects to remote MCP servers using OAuth 2.1, PKCE, and Dynamic Client Registration
- [API Reference](https://docs.hiperai.com/api.md)
- [Authentication Overview](https://docs.hiperai.com/api/auth/overview.md)
- [Health Check](https://docs.hiperai.com/api/system/health.md): Check if the API is running and healthy. No authentication required.
- [Chat Completion](https://docs.hiperai.com/api/chat/completions.md): The main endpoint for AI chat completions with optional knowledge base retrieval (RAG). This endpoint supports multiple AI models, security policies, and can search your knowledge bases for relevant context to enhance responses.
- [OpenAI-Compatible Endpoint](https://docs.hiperai.com/api/chat/openai-compatible.md): Drop-in OpenAI Chat Completions surface — point any OpenAI SDK at SecureAI
- [Redundancy & Failover](https://docs.hiperai.com/api/redundancy.md): Caller-defined model failover chains for the SecureAI Completions API
- [Generate Images](https://docs.hiperai.com/api/images/generations.md): Generate new images from text prompts or transform existing images using Google Gemini 2.5 Flash Image. All requests and responses are processed through SMLTP for security and compliance.
- [Edit Images](https://docs.hiperai.com/api/images/edits.md): Edit existing images using Google Gemini 2.5 Flash Image with text instructions. All requests and responses are processed through SMLTP for security and compliance.
- [Initiate Speech-to-Speech WebRTC Session](https://docs.hiperai.com/api/speech/webrtc.md): Establishes a WebRTC connection for real-time speech-to-speech conversations using OpenAI Realtime API. This endpoint accepts a WebRTC SDP offer and returns an SDP answer that can be used to establish a peer connection with OpenAI's Realtime API.
- [Get S2S Time Status](https://docs.hiperai.com/api/speech/status.md): Retrieve the current Speech-to-Speech (S2S) time status for the billing user, including remaining time, total monthly limit, used time, and renewal information.
- [Log S2S Session Duration](https://docs.hiperai.com/api/speech/log-session.md): Log the duration of a completed Speech-to-Speech session and deduct the time from the user's S2S time quota. This should be called after a session ends to track usage accurately.
- [Available Models](https://docs.hiperai.com/api/discovery/models.md): Retrieve available AI models based on your API key permissions and user license. Models are categorized as 'standard' or 'premium' based on your subscription tier.
- [List All Indexes](https://docs.hiperai.com/api/indexes/list.md): Retrieve all available knowledge base indexes
- [Create Index](https://docs.hiperai.com/api/indexes/create.md): Create a new knowledge base index
- [Update Index](https://docs.hiperai.com/api/indexes/update.md): Update an existing knowledge base index
- [Search Index for Documents](https://docs.hiperai.com/api/indexes/search.md): Search documents within an index using semantic search. Returns matching documents with relevance scores.
- [Train Index with Documents](https://docs.hiperai.com/api/indexes/train.md): Train an index by uploading documents (files) or providing text inputs. Supports multiple file formats: TXT, PDF, DOCX, DOC, JSON, CSV, XLS, XLSX. Files can be uploaded as multipart/form-data or text can be provided as JSON.
- [Available Knowledge Bases](https://docs.hiperai.com/api/discovery/indexes.md): Retrieve available knowledge bases (indexes) that your API key can access. Includes personal indexes, shared indexes, and the Zero-Knowledge option.
- [Policy Check (Dry Run)](https://docs.hiperai.com/api/policy-check.md): Validate a completion request against every SecureAI policy without calling a model or spending points
- [Prompt Shield API](https://docs.hiperai.com/api/threat-defense/prompt-shield.md)
- [SMLTP Policies](https://docs.hiperai.com/api/smltp/policies.md): Retrieve all SMLTP security policies
- [Active SMLTP Policies](https://docs.hiperai.com/api/smltp/active.md): Retrieve currently active SMLTP policies
- [Create SMLTP Policy](https://docs.hiperai.com/api/smltp/create.md): Create a new SMLTP security policy
- [Compliance Receipts](https://docs.hiperai.com/api/receipts.md): Fetch the signed SMLTP compliance receipt for a completion
- [Audit Logs](https://docs.hiperai.com/api/smltp/audit-logs.md): Retrieve SMLTP audit logs
- [Security Policies](https://docs.hiperai.com/api/discovery/smltp-policies.md): Retrieve available SMLTP (Secure Multi-Layer Trust Protocol) security policies. These policies determine how your data is processed and protected.
- [Get All Users](https://docs.hiperai.com/api/users/list.md): Retrieve all users with pagination and filtering. Only accessible by administrators.
- [Create New User](https://docs.hiperai.com/api/users/create.md): Create a new user account. Only accessible by administrators.
- [Update User](https://docs.hiperai.com/api/users/update.md): Update an existing user account
- [List Roles](https://docs.hiperai.com/api/roles/list.md): Retrieve all available user roles
- [Create Role](https://docs.hiperai.com/api/roles/create.md): Create a new user role
- [List Groups](https://docs.hiperai.com/api/groups/list.md): Retrieve all user groups
- [Create Group](https://docs.hiperai.com/api/groups/create.md): Create a new user group
- [Update Group](https://docs.hiperai.com/api/groups/update.md): Update an existing user group
- [Usage & Quota](https://docs.hiperai.com/api/usage.md): Self-service points, budget, and rate-limit snapshot for an API key
- [Billing Mode API Keys](https://docs.hiperai.com/api/billing-modes.md)
- [Billing Modes Quick Reference](https://docs.hiperai.com/api/billing-modes/quick-reference.md)
- [Licenses Availability](https://docs.hiperai.com/api/billing-modes/licenses-availability.md): Retrieve current license pool limits, usage, and remaining (admin only)
- [Webhooks Overview](https://docs.hiperai.com/api/webhooks/overview.md): Receive real-time security and platform events from SecureAI via signed HTTP webhooks
- [Webhook Events](https://docs.hiperai.com/api/webhooks/events.md): The SecureAI webhook event catalog

## OpenAPI Specs

- [openapi](/openapi.yaml)