# SUPERWISE® Docs: Runtime Agentic AI Governance & Operations Documentation > Access SUPERWISE® documentation for runtime agentic AI governance and operations. Learn runtime policies, JSON schema validation, guardrails, and Python SDK deployment for enterprise agent applications. ## Guides - [Welcome aboard](https://docs.superwise.ai/docs/welcome.md) - [Introduction to SUPERWISE®](https://docs.superwise.ai/docs/introduction-to-superwise.md): Everything you need to know about SUPERWISE® in one minute - [Quickstart](https://docs.superwise.ai/docs/quickstart.md) - [Build a new agent](https://docs.superwise.ai/docs/build-a-new-gen-ai-app.md) - [Monitor data and models](https://docs.superwise.ai/docs/monitor-your-data.md) - [Dataset](https://docs.superwise.ai/docs/dataset-1.md) - [Schema](https://docs.superwise.ai/docs/schema.md) - [Data type](https://docs.superwise.ai/docs/data-type.md) - [Source](https://docs.superwise.ai/docs/source.md) - [Destination](https://docs.superwise.ai/docs/destination.md) - [Policy](https://docs.superwise.ai/docs/policy.md) - [Dashboard](https://docs.superwise.ai/docs/dashboard.md) - [Agent](https://docs.superwise.ai/docs/application.md) - [Knowledge](https://docs.superwise.ai/docs/knowledge.md) - [Guardrails](https://docs.superwise.ai/docs/guardrails.md): Real-time firewall rules that detect and redact secrets, PII, and toxic content in inbound prompts - [Tag](https://docs.superwise.ai/docs/tag.md) - [Account management](https://docs.superwise.ai/docs/account-management.md): Manage your authentication process, users, and security factors - [Manage users](https://docs.superwise.ai/docs/manage-users.md): Cause it's more fun with your teammates around - [Generate tokens](https://docs.superwise.ai/docs/generate-tokens.md): How to generate client ID and secret key to authenticate your access via code - [Multi-Factor Authentication](https://docs.superwise.ai/docs/multi-factor-authentication.md): Enforce Multi-Factor Authentication - [SSO configuration](https://docs.superwise.ai/docs/sso-configuration.md) - [Switch accounts](https://docs.superwise.ai/docs/switch-tenants.md): Move seamlessly between organizations in your SUPERWISE® environment - [Connect Microsoft Teams](https://docs.superwise.ai/docs/destinations.md) - [Managing agents](https://docs.superwise.ai/docs/build-application.md) - [Developing an agent](https://docs.superwise.ai/docs/developing-an-agent.md): Rapidly build, customize, and integrate enterprise-grade AI capabilities into any agent. - [Create a basic LLM assistant agent](https://docs.superwise.ai/docs/create-basic-llm-assistant-application.md) - [Create an AI assistant retrieval agent](https://docs.superwise.ai/docs/ai-assistent-retrieval-app.md) - [Create an advanced agent](https://docs.superwise.ai/docs/advanced-agent-app.md) - [Index your knowledge base](https://docs.superwise.ai/docs/index-your-knowledge-base.md) - [Configuring an LLM model](https://docs.superwise.ai/docs/register-openai-compatible-model.md) - [Improve agent performance](https://docs.superwise.ai/docs/improve-application-preformence.md): Discover expert tips to fine-tune your model's performance for optimal results - [Register an external agent](https://docs.superwise.ai/docs/register-an-external-agent.md) - [Deploying agents](https://docs.superwise.ai/docs/deploying-superwise-apps.md) - [Test before you publish](https://docs.superwise.ai/docs/using-the-chat-1.md) - [Integrate your agent](https://docs.superwise.ai/docs/embed-your-app.md) - [Managing versions](https://docs.superwise.ai/docs/publish-a-version.md) - [Operate an agent](https://docs.superwise.ai/docs/operate-an-agent.md) - [Agent authentication](https://docs.superwise.ai/docs/authentication.md) - [Connect guardrails](https://docs.superwise.ai/docs/guardrails-2.md) - [Monitor your agent](https://docs.superwise.ai/docs/monitor-your-app.md) - [Guardrails](https://docs.superwise.ai/docs/guardrails-1.md) - [Configure a Guardrail](https://docs.superwise.ai/docs/configuring-a-guardrail.md) - [PII detection](https://docs.superwise.ai/docs/pii-detection.md) - [Jailbreak detection](https://docs.superwise.ai/docs/jailbreak-detection.md) - [String check](https://docs.superwise.ai/docs/string-check.md) - [Competitor check](https://docs.superwise.ai/docs/competitor-check.md) - [Correct language](https://docs.superwise.ai/docs/correct-language.md) - [Allowed topics](https://docs.superwise.ai/docs/allowed-topics.md) - [Restricted topics](https://docs.superwise.ai/docs/restricted-topics.md) - [Toxicity detection](https://docs.superwise.ai/docs/toxicity-detection.md) - [Resolution level](https://docs.superwise.ai/docs/image-resolution.md) - [Sharpness level](https://docs.superwise.ai/docs/sharpness-level.md) - [Semantic image](https://docs.superwise.ai/docs/semantic-image.md) - [Image tampering detection](https://docs.superwise.ai/docs/image-tampering-detection.md) - [License plate](https://docs.superwise.ai/docs/license-plate.md) - [Face detection](https://docs.superwise.ai/docs/face-detection.md) - [Publish a Guardrail](https://docs.superwise.ai/docs/publishing-a-guardrail.md) - [Monitor your Guardrail](https://docs.superwise.ai/docs/monitor-guardrail.md) - [Observability](https://docs.superwise.ai/docs/observability.md) - [Ingesting data](https://docs.superwise.ai/docs/connecting.md) - [Connect new source](https://docs.superwise.ai/docs/connect-new-source.md) - [Create dataset and connect it to a source](https://docs.superwise.ai/docs/create-dataset-and-connect-it-to-a-source.md) - [Ingest data via REST API](https://docs.superwise.ai/docs/ingest-data-via-rest-api.md) - [Get alerts on failed ingestion](https://docs.superwise.ai/docs/view-and-get-alerts-on-failed-ingestion-via-events.md): View and get alerts on failed ingestion (via events) - [Explore your data](https://docs.superwise.ai/docs/explore-your-data-by-creating-insightful-queries.md): Explore your data by creating insightful queries - [Create Dashboard](https://docs.superwise.ai/docs/create-dashboard.md) - [Calculate Drift metrics](https://docs.superwise.ai/docs/calculate-drift-metrics.md) - [Monitoring](https://docs.superwise.ai/docs/monitoring.md) - [Create a monitoring policy](https://docs.superwise.ai/docs/create-monitoring-policy.md) - [Sentinels](https://docs.superwise.ai/docs/sentinels.md): The enterprise AI firewall — a single control plane to secure and standardize decentralized AI operations. - [Concepts](https://docs.superwise.ai/docs/concepts.md): How Sentinel is built, and how it keeps your data private - [Architecture](https://docs.superwise.ai/docs/architecture.md): Decentralized architecture: SaaS meets Sentinel - [Data privacy](https://docs.superwise.ai/docs/data-privacy.md): The privacy boundary between your VPC and the SUPERWISE® cloud - [Get started](https://docs.superwise.ai/docs/getting-started.md): Install the CLI, deploy a gateway, and route your first request - [Deploy a gateway](https://docs.superwise.ai/docs/deploy-a-gateway.md): Deploy a Sentinel gateway via Docker, CLI, or Helm - [Custom providers](https://docs.superwise.ai/docs/custom-providers.md): Proxy self-hosted or alternative OpenAI-compatible models through Sentinel - [Connect your applications](https://docs.superwise.ai/docs/connect-your-applications.md): Zero-code instrumentation of AI apps using proxy environment variables - [Environment-variable instrumentation](https://docs.superwise.ai/docs/environment-variables.md): Manually point provider base-URL variables at your Sentinel gateway - [Sentinel CLI proxy](https://docs.superwise.ai/docs/sentinel-cli-proxy.md): Let the Sentinel CLI manage system-wide proxy environment variables - [Guardrails](https://docs.superwise.ai/docs/guardrails.md): Real-time firewall rules that detect and redact secrets, PII, and toxic content in inbound prompts - [Manage guardrails](https://docs.superwise.ai/docs/manage-guardrails.md): Add or remove guardrails on a specific Sentinel from the app - [Secret & credential detection](https://docs.superwise.ai/docs/secret-credential-detection.md): Redact exposed API keys, cloud credentials, and private tokens - [PII redaction](https://docs.superwise.ai/docs/pii-redaction.md): Redact personally identifiable information before it reaches the model - [Rudeness & toxicity](https://docs.superwise.ai/docs/rudeness-toxicity.md): Redact profanity, hostile language, and harassment from inbound prompts - [Activity log](https://docs.superwise.ai/docs/activity-log.md): Watch interactions stream through your gateways in real time - [Operational dashboard](https://docs.superwise.ai/docs/operational-dashboard.md): Health, security value, and latency across your Sentinel fleet - [FinOps dashboard](https://docs.superwise.ai/docs/finops-dashboard.md): Understand and optimize token consumption across your Sentinel fleet - [Reference](https://docs.superwise.ai/docs/reference.md): Providers and routes, CLI commands, and environment variables - [Deployment methods](https://docs.superwise.ai/docs/deployment-methods.md) - [GCP requirements](https://docs.superwise.ai/docs/gcp-requirements.md) - [Security](https://docs.superwise.ai/docs/security.md) - [REST API](https://docs.superwise.ai/docs/rest-api.md) - [SDK](https://docs.superwise.ai/docs/sdk.md) - [I need help!](https://docs.superwise.ai/docs/i-need-help.md): We got your back - [MCP](https://docs.superwise.ai/docs/mcp.md) ## API Reference - [Welcome to the API reference guide](https://docs.superwise.ai/reference/welcome-to-the-api-reference-guide.md): Everything you need to know about Superwise APIs - [Getting started with your API](https://docs.superwise.ai/reference/getting-started-with-your-api-1.md): Let's get started with user authentication - [Creating a bearer token](https://docs.superwise.ai/reference/getting-started-with-your-api.md): This page will help you get started with Authentication. - [Get Agents](https://docs.superwise.ai/reference/get_agents.md): Get agents with global search or specific filters. If search is provided, it takes priority over filters. - [Create Agent](https://docs.superwise.ai/reference/create_agent.md): Create a new agent. - [Get Credential Schema](https://docs.superwise.ai/reference/get_credential_schema.md): Get the credential schema for a flowise agent. - [Get Model Status](https://docs.superwise.ai/reference/get_model_status.md) - [Get Provider Config](https://docs.superwise.ai/reference/get_llm_models.md) - [Test Model Connection](https://docs.superwise.ai/reference/test_model_connection.md) - [Test Tool Connection](https://docs.superwise.ai/reference/test_tool_connection.md): Test a tool connection. Parameters: For `ToolConfigPostgres`: - **type**: Literal type indication for Postgres tool (`Postgres`). - **connection_string**: Connection string for the Postgres database. For `ToolConfigMySQL`: - **type**: Literal type indication for MySQL tool (`MySQL`). - **connection_string**: Connection string for the MySQL database. For `ToolConfigMSSQL`: - **type**: Literal type indication for MSSQL tool (`MSSQL`). - **connection_string**: Connection string for the MSSQL database. For `ToolConfigOracle`: - **type**: Literal type indication for Oracle tool (`Oracle`). - **connection_string**: Connection string for the Oracle database. For `ToolConfigBigQuery`: - **type**: Literal type indication for BigQuery tool (`BigQuery`). - **project_id**: Project ID for BigQuery. - **dataset_id**: Dataset ID for BigQuery. - **service_account**: Service account information as a dictionary with keys and values as strings. For `ToolConfigPGVector`: - **type**: Literal type indication for PG Vector tool (`PGVector`). - **connection_string**: Connection string for the PG Vector database. - **table_name**: Name of the table in the PG Vector database. - **embedding_model**: Configuration of the embedding model to be used. - **provider**: Provider of the embedding model (`VertexAIModelGarden`). - **project_id**: Project ID for Vertex AI. - **endpoint_id**: Endpoint ID for the model. - **location**: Location of the Vertex AI endpoint. - **service_account**: Service account information as a dictionary with keys and values as strings. - [Get Agent By Id](https://docs.superwise.ai/reference/get_agent_by_id.md): Get an agent by id. - [Patch Agent](https://docs.superwise.ai/reference/patch_agent.md) - [Delete Agent](https://docs.superwise.ai/reference/delete_agent.md): Delete an agent. - [Create Agent Dataset](https://docs.superwise.ai/reference/create_agent_dataset.md): Create a new dataset for agent. - [Regenerate Api Token](https://docs.superwise.ai/reference/regenerate_api_token.md) - [Create Version](https://docs.superwise.ai/reference/create_version.md): Create a new version. - [Get Agent Versions](https://docs.superwise.ai/reference/get_agent_versions.md): Get versions of the specified agent. - [Patch Version](https://docs.superwise.ai/reference/patch_version.md): Patch a version. - [Get Agent Version](https://docs.superwise.ai/reference/get_agent_version.md): Get specified version of specified agent. - [Ask](https://docs.superwise.ai/reference/ask_ask_post.md) - [Feedback](https://docs.superwise.ai/reference/feedback_feedback_post.md): Publish feedback to events Parameters: - **interaction_id**: A UUID representing the message id of the interaction - **question**: A string representing the question that was asked by the user - **answer**: A string representing the answer that was given by the AI - **is_positive**: A boolean representing the feedback is positive or negative - **negative_feedback_category_harmful**: A boolean representing the feedback category harmful - **negative_feedback_category_untrue**: A boolean representing the feedback category untrue - **negative_feedback_category_unhelpful**: A boolean representing the feedback category unhelpful - **negative_feedback_category_other**: A boolean representing the feedback category other - **feedback_description**: A string representing the feedback description - [Get Tagged Agents](https://docs.superwise.ai/reference/get_tagged_agents.md): Get all ids tagged by *all* tags. - [Add Agent Tags](https://docs.superwise.ai/reference/add_agent_tags.md): Add tags to agent. - [Delete Agent Tags](https://docs.superwise.ai/reference/delete_agent_tags.md): Delete tags from agent. - [Agent Bulk Action](https://docs.superwise.ai/reference/agent_bulk_action.md): Perform a bulk action on a list of agents. - [Activate Agent](https://docs.superwise.ai/reference/activate_agent.md) - [Archive Agent](https://docs.superwise.ai/reference/archive_agent.md) - [Deactivate Agent](https://docs.superwise.ai/reference/deactivate_agent.md) - [Unarchive Agent](https://docs.superwise.ai/reference/unarchive_agent.md) - [Ask Stream](https://docs.superwise.ai/reference/ask_stream_ask_stream_post.md): Stream AI response for the given input. This endpoint accepts a conversational input and streams the AI-generated response in chunks as they become available. - [Verify Dataset Schema](https://docs.superwise.ai/reference/verify_agent_dataset_schema.md) - [Deactivate Agent](https://docs.superwise.ai/reference/deactivate_agent_v1_agents__agent_id__unpublish_post.md) - [Ask Playground](https://docs.superwise.ai/reference/ask_playground_v1_application_playground_ask_post.md): Proxy ask request to the playground service. - [Ask Stream Playground](https://docs.superwise.ai/reference/ask_stream_playground_v1_application_playground_ask_stream_post.md): Proxy streaming ask request to the playground service. - [Get Dashboards Items](https://docs.superwise.ai/reference/get_dashboards_items.md): Get all dashboard items of tenant, excepts multiple filters :return: List[DashboardITem] - [Create Dashboard Item](https://docs.superwise.ai/reference/create_dashboard_item.md): Creates a new dashboard item while assigning it to a dashboard :return: DashboardItem - [Get Dashboard](https://docs.superwise.ai/reference/get_dashboard_item.md): returns a specific dashboard item according to id :return: DashboardItem - [Delete dashboard item by ID](https://docs.superwise.ai/reference/delete_dashboard_item.md) - [Update dashboard item by ID](https://docs.superwise.ai/reference/update_dashboard_item.md) - [Get Dashboards](https://docs.superwise.ai/reference/get_dashboards.md) - [Create Dashboard](https://docs.superwise.ai/reference/create_dashboard.md) - [Get Dashboard](https://docs.superwise.ai/reference/get_dashboard.md) - [Delete dashboard by ID](https://docs.superwise.ai/reference/delete_dashboard.md) - [Update dashboard by ID](https://docs.superwise.ai/reference/update_dashboard.md) - [Search Dashboards](https://docs.superwise.ai/reference/search_dashboards.md) - [Get Tagged Dashboards](https://docs.superwise.ai/reference/get_tagged_dashboards.md): Get all ids tagged by *all* tags. - [Add Dashboard Tags](https://docs.superwise.ai/reference/add_dashboard_tags.md): Add tags to dashboard. - [Delete Dashboard Tags](https://docs.superwise.ai/reference/delete_dashboard_tags.md): Delete tags from dashboard. - [Dashboard Bulk Action](https://docs.superwise.ai/reference/dashboard_bulk_action.md): Perform a bulk action on a list of dashboards. - [Archive Dashboard](https://docs.superwise.ai/reference/archive_dashboard.md): Add tags to dashboard. - [Unarchive Dashboard](https://docs.superwise.ai/reference/unarchive_dashboard.md): Add tags to dashboard. - [Get All Dataset Model Info](https://docs.superwise.ai/reference/get_all_dataset_model_info.md): Get all Dataset-Model connections and details - **size**: Number of items per page (use it to get more items than 25 -> all items) - **page**: Page number - [Connect Dataset Model](https://docs.superwise.ai/reference/connect_dataset_model.md): Connect a Dataset to a Model - **dataset_id** (str): Required. The dataset id. - **model_id** (str): Required. The model id. - [Disconnect Dataset Model](https://docs.superwise.ai/reference/disconnect_dataset_model.md): Disconnect a Dataset from a Model - **dataset_id** (str): Required. The dataset id. - **model_id** (str): Required. The model id. - [Get Dataset Sources](https://docs.superwise.ai/reference/get_dataset_sources.md): Retrieve all Dataset Sources based on the provided filters. - **source_id**: ID of the source - **folder**: Path within the bucket to ingest data from - **id**: ID of the dataset source - **dataset_id**: ID of the dataset - **created_by**: Creator of the dataset source - **ingest_type**: Type of ingestion - [Create Dataset Source](https://docs.superwise.ai/reference/create_dataset_source.md): Create a new DatasetSource. - **dataset_id** (str): Required, ID of the dataset. The dataset must already exist. - **source_id** (UUID): Required, Unique Identifier(UUID) of the source data. The source must already exist. - **folder** (str or None): Optional, Path within the bucket to ingest data from.. - **query** (str or None): Optional, Query statement to retrieve data. - **created_at** (datetime or None): Optional, Timestamp when the data source was created. - **updated_at** (datetime or None): Optional, Timestamp when the data source was last updated. - **ingest_type** (IngestType): Optional, Type of data ingestion. Default is IngestType.INSERT. - [Get Dataset Source](https://docs.superwise.ai/reference/get_dataset_source.md): Retrieve a Dataset Source based on the dataset_source_id. - **dataset_source_id**: ID of the dataset source - [Delete Dataset Source](https://docs.superwise.ai/reference/delete_dataset_source.md): Delete a specific DatasetSource. - **dataset_source_id**: ID of the dataset source - [Update Dataset Source](https://docs.superwise.ai/reference/update_dataset_source.md): Update an existing DatasetSource. - **id** (str): Optional, ID of the dataset source. - **dataset_id** (str): Optional, ID of the dataset. The dataset must already exist. - **source_id** (UUID): Optional, Unique Identifier(UUID) of the source data. The source must already exist. - **folder** (str or None): Optional, Path within the bucket to ingest data from. - **query** (str or None): Optional, Query statement to retrieve data. - **ingest_type** (IngestType): Optional, Type of data ingestion. Default is IngestType.INSERT. - [Get Datasets](https://docs.superwise.ai/reference/get_datasets.md): Retrieve all Datasets based on search query OR provided filters - **search** (str or None): Optional, Global search query to filter datasets across multiple fields (id, name, created_at, updated_at). If provided, specific filters are ignored. - **name** (str or None): Optional, Name of the dataset based on which records to be fetched. - **description** (str or None): Optional, Description of the dataset based on which records to be fetched. - **id** (str or None): Optional, Unique identifier of the dataset based on which records to be fetched. - **model_version_id** (str or None): Optional, Model version identifier based on which datasets to be fetched. - **created_by** (str or None): Optional, Identifier of the user who created the datasets based on which datasets to be fetched. - [Create Dataset](https://docs.superwise.ai/reference/create_dataset.md): Create a new Dataset - **payload** (DatasetCreate): Required. The payload that includes: - **name** (str): Name of the dataset, min_length=1, max_length=100. - **description** (str or None): A description about the dataset. - **model_version_id** (str or None): Model version identifier. - **tags** (list of DatasetTag or None): A list of tags related to the dataset. - **schema** (Schema): The schema of the dataset. - [Log Conversation](https://docs.superwise.ai/reference/log_conversation_v1_datasets_log_conversation_post.md) - [Search Datasets](https://docs.superwise.ai/reference/search_datasets.md): Retrieve all Datasets based on search params - [Get Dataset](https://docs.superwise.ai/reference/get_dataset.md): Fetch a specific Dataset - **dataset_id** (str): Required, ID of the dataset to be fetched. - **warehouse_schema** (bool): Optional. When true, schema types are converted for warehouse consumers (e.g. image→json). - [Delete Dataset](https://docs.superwise.ai/reference/delete_dataset.md): Delete a specific Dataset - **dataset_id** (str): Required, ID of the dataset to be deleted. - [Update Dataset](https://docs.superwise.ai/reference/update_dataset.md): Update an existing Dataset - **payload** (DatasetUpdate): Required. The payload that includes: - **name** (str or None): Updated name of the dataset. - **description** (str or None): A revised description about the dataset. - **id** (str or None): Unique identifier of the dataset. - **model_version_id** (str or None): Updated model version identifier. - **created_by** (str or None): Identifier of the user who updated the dataset. - **tags** (list of str or None): A list of updated tags related to the dataset. - **schema** (SchemaUpdate or None): The updated schema of the dataset. - [Log](https://docs.superwise.ai/reference/log_v1_datasets__dataset_id__log_post.md): Log a record. Accepts application/json or multipart/form-data (with images). - [Get Models By Dataset Id](https://docs.superwise.ai/reference/get_models_by_dataset_id.md): Retrieve all Models connected to a Dataset - **dataset_id** (str): Required, ID of the dataset to fetch models. - [Get Tagged Datasets](https://docs.superwise.ai/reference/get_tagged_datasets.md): Get all dataset IDs tagged with the specified tag. - [Add Dataset Tags](https://docs.superwise.ai/reference/add_dataset_tags.md): Add tags to dataset. - [Delete Dataset Tags](https://docs.superwise.ai/reference/delete_dataset_tags.md): Delete tags from dataset. - [Dataset Bulk Action](https://docs.superwise.ai/reference/dataset_bulk_action.md): Perform a bulk action on a list of datasets. - [Archive Dataset](https://docs.superwise.ai/reference/archive_dataset.md) - [Unarchive Dataset](https://docs.superwise.ai/reference/unarchive_dataset.md) - [Get Media](https://docs.superwise.ai/reference/get_media.md): Retrieve a single image from GCS by encoded image_id. - [Log Batch](https://docs.superwise.ai/reference/log_batch_v1_datasets_log_batch_post.md) - [Run Nl Query](https://docs.superwise.ai/reference/run_nl_query.md): Convert a natural language request to SQL and execute it against datasets. - **query** (str): Required. Plain English description of the data you want. - **dataset_ids** (list[str]): Required. Dataset IDs to scope the query. - **generate_only** (bool): Optional. When True, return generated SQL + sqlglot validation without executing. - [Run Sql Query](https://docs.superwise.ai/reference/run_sql_query.md): Validate or execute an SQL SELECT statement against datasets. - **sql** (str): Required. A SELECT statement where table names are dataset IDs. - **validate_only** (bool): Optional. When True, validate without executing. - [Update Record](https://docs.superwise.ai/reference/update_record_v1_datasets__dataset_id__update_post.md) - [Get Destinations](https://docs.superwise.ai/reference/get_destinations.md): Get all available destinations based on the provided filters - **destination_id** (List[UUID]): Optional filter by destination IDs. - **integration_id** (List[UUID]): Optional filter by related integration IDs. - **name** (List[str]): Optional filter by destination names. - **created_by** (List[str]): Optional filter by creation user IDs. - [Create Destination](https://docs.superwise.ai/reference/create_destination.md): Create a new destination - **base_destination_create** (DestinationCreateBase): Required. The payload that includes: - **name** (str): Name of the new destination. - **integration_id** (UUID): Unique identifier of the integration to which the destination would be created. For Microsoft Teams, Email, or Webhook, omit this and set **integration_type** to `teams`, `email`, or `webhook` on the first destination for that channel so a tenant integration row is created automatically (Teams webhook URLs, Email recipient lists, and Webhook URLs/headers live on each destination's **params**). - **integration_type** (IntegrationType): Optional. Must be `teams`, `email`, or `webhook` when **integration_id** is omitted. When **integration_id** is set, you may pass `slack`, `teams`, `email`, or `webhook` for a consistent payload shape; it must match the integration's type or be omitted. - **params** (dict): Additional parameters for the creation of the destination. - [Get Destination By Id](https://docs.superwise.ai/reference/get_destination.md): Get a specific destination by ID - **destination_id** (UUID): The unique identifier of the destination. - [Delete Destination By Id](https://docs.superwise.ai/reference/delete_destination.md): Delete a specific destination by ID - **destination_id** (UUID): The unique identifier of the destination. - [Update Destination By Id](https://docs.superwise.ai/reference/update_destination.md): Update a specific destination by ID - **base_destination_update** (DestinationUpdateBase): The payload containing the update data for the destination, which includes: - **name** (str): The updated name of the destination. - **params** (dict): A dictionary containing key-value pairs for parameters to be updated. - [Test Webhook](https://docs.superwise.ai/reference/test_webhook.md): Test destination connectivity for Teams, Slack, Email, or generic Webhook. For **teams**, POSTs a test JSON body to **webhook_url** (HTTP webhook / workflow). For **slack**, sends a test message via the **Slack Web API** using the stored bot token and **channel_id**—not an outbound POST to a caller-supplied URL. No destination row is required for that channel; the test only needs a valid Slack integration and channel id. For **email**, sends a short SMTP test message to the listed addresses. For **webhook**, POSTs a sample JSON payload to the supplied **webhook_url** with optional custom **headers**. - **request** (DestinationTestRequest): Required. The payload that includes: - **integration_type** (IntegrationType): `teams`, `slack`, `email`, or `webhook` - **webhook_url** (HttpUrl): Required for `teams` and `webhook`. Target URL for the test POST. - **integration_id** (UUID): Required for `slack`. Slack integration identifier. - **channel_id** (str): Required for `slack`. Slack channel ID. - **emails** (List[str]): Required for `email`. Recipient addresses. - **headers** (dict[str, str]): Optional for `webhook`. Custom HTTP headers to attach. - [Get Guardrails](https://docs.superwise.ai/reference/get_guardrails.md): Get guardrails list with pagination. - [Create Guardrail](https://docs.superwise.ai/reference/create_guardrail.md): Create a new guardrail. - [Guardrail Run](https://docs.superwise.ai/reference/guardrail_run.md): Run guardrules. Accepts application/json (text-only) or multipart/form-data (with optional images, up to MAX_IMAGES). - [Get Guardrail Schema](https://docs.superwise.ai/reference/get_guardrail_schema.md): Return JSON schema for all available guard payloads dynamically. - [Guardrail Validate](https://docs.superwise.ai/reference/guardrail_validate.md): Route handler delegating guardrail validate to the service layer. - [Get Guardrail By Id](https://docs.superwise.ai/reference/get_guardrail_by_id.md): Get guardrail by id. - [Patch Guardrail](https://docs.superwise.ai/reference/patch_guardrail.md): Patch a guardrail. - [Delete Guardrail](https://docs.superwise.ai/reference/delete_guardrail.md): Delete a guardrail. - [Search Guardrails](https://docs.superwise.ai/reference/search_guardrails.md): Get guardrails list with pagination. - [Get Tagged Guardrails](https://docs.superwise.ai/reference/get_tagged_guardrails.md): Get all ids tagged by *all* tags. - [Add Guardrail Tags](https://docs.superwise.ai/reference/add_guardrail_tags.md): Add tags to guardrail. - [Delete Guardrail Tags](https://docs.superwise.ai/reference/delete_guardrail_tags.md): Delete tags from guardrail. - [Guardrail Bulk Action](https://docs.superwise.ai/reference/guardrail_bulk_action.md): Perform a bulk action on a list of guardrails. - [Archive Guardrail](https://docs.superwise.ai/reference/archive_guardrail.md) - [Unarchive Guardrail](https://docs.superwise.ai/reference/unarchive_guardrail.md) - [Create Guardrail Dataset](https://docs.superwise.ai/reference/create_guardrail_dataset.md) - [Verify Dataset Schema](https://docs.superwise.ai/reference/verify_dataset_schema.md): Verify that a dataset has the required schema for guardrail observability. - [Create Knowledge](https://docs.superwise.ai/reference/create_knowledge.md): Create a new knowledge object. - [Get Knowledges](https://docs.superwise.ai/reference/get_knowledge_objects.md): Get Knowledge objects. - [Get File Info](https://docs.superwise.ai/reference/get_file_info.md): Get file information for a list of file IDs. - [Upload Files](https://docs.superwise.ai/reference/upload_files.md): Upload files to cloud storage. - [Delete Knowledge](https://docs.superwise.ai/reference/delete_knowledge.md): Delete an knowledge object. - [Get Knowledge By Id](https://docs.superwise.ai/reference/get_knowledge_by_id.md): Get a knowledge object by id. - [Update knowledge object](https://docs.superwise.ai/reference/update_knowledge.md) - [Reindex knowledge documents](https://docs.superwise.ai/reference/reindex_knowledge.md) - [Get Integrations](https://docs.superwise.ai/reference/get_integrations.md): Get all available integrations - **integration_type** (IntegrationType): Optional filter by integration type - **created_by** (str): Optional filter by user ID who created the integration. - [Get Integration By Id](https://docs.superwise.ai/reference/get_integration.md): Get a specific integration by ID - **integration_id** (UUID): The unique identifier of the integration. - [Delete Integration By Id](https://docs.superwise.ai/reference/delete_integration.md): Delete a specific integration by ID - **integration_id** (UUID): The unique identifier of the integration. - **delete_destinations** (bool): Whether or not to delete destinations associated with the integration. - [Distribution](https://docs.superwise.ai/reference/distribution.md) - [Distribution Multi](https://docs.superwise.ai/reference/distribution-multiple.md) - [Performance](https://docs.superwise.ai/reference/performance.md) - [Performance Multi](https://docs.superwise.ai/reference/performance-multiple.md) - [Get Models](https://docs.superwise.ai/reference/get_models.md): Get all Models with optional filters - **payload** (ModelFilters): Optional. The payload that includes: - **name** (str): Name of the model. - **id** (str): Unique identifier of the model. - **created_by** (str): User who created the model. - [Create Model](https://docs.superwise.ai/reference/create_model.md): Create a new Model - **payload** (ModelCreate): Required. The payload that includes: - **name** (str): Name of the model, min_length=1, max_length=100. - **description** (str or None): A description about the model. - **id** (str or None): Unique identifier of the model. If not provided, it will be generated. - [Get Model By Id](https://docs.superwise.ai/reference/get_model_by_id.md): Get a Model by id - [Delete Model](https://docs.superwise.ai/reference/delete_model.md): Delete a Model by id - [Update Model](https://docs.superwise.ai/reference/update_model.md): Update a Model by id - **model_id** (str): Required. The id of the model to be updated. - **payload** (ModelUpdate): Required. The payload that includes: - **name** (str): Name of the model, min_length=1, max_length=100. - **description** (str or None): A description about the model. - [Get Datasets By Model Id](https://docs.superwise.ai/reference/get_datasets_by_model_id.md): Get all Datasets connected to a Model by id - **model_id** (str): Required. The id of the model to get datasets for. - [Get Guardrail Versions](https://docs.superwise.ai/reference/get_guardrail_versions.md): Get all guardrail versions. - [Run Guardrail Versions](https://docs.superwise.ai/reference/run_guardrail_versions.md): Run guardrail versions. Accepts application/json (text-only) or multipart/form-data (with optional images, up to MAX_IMAGES). - [Patch Guardrail Version](https://docs.superwise.ai/reference/patch_guardrail_version.md): Patch a guardrail version. - [Create Guardrail Version](https://docs.superwise.ai/reference/create_guardrail_version.md): Create a new guardrail version. - [Get Policies](https://docs.superwise.ai/reference/get_policies.md): Retrieve all Policies based on provided filters - **name** (str or None): Optional. The name of the policy to filter by. - **status** (PolicyStatus or None): Optional. The status of the policy to filter by. - **created_by** (str or None): Optional. The creator of the policy to filter by. - **dataset_id** (str or None): Optional. The ID of the dataset associated with the policy to filter by. - **search** (str or None): Optional. Global search term that searches across policy ID, name, and updated_at fields. If both search and specific filters are provided, search takes precedence. Raises: 500: If there is a server error. 404: If the requested resource is not found. 200: If the operation is successful. - [Create Policy](https://docs.superwise.ai/reference/create_policy.md): Creates a new Policy - **payload** (PolicySchema): Required. The policy data to be created: - **name** (str): A descriptive name for this policy. - **data_config**: Configuration relevant to the retrieval of data for this policy: for compare distribution policy: - **query_a** (Query): Cube.js query. - **query_b** (Query): Cube.js query. - **query_a_time_range_config**: (TimeRangeConfig or None): Time range configuration for query A. - **query_b_time_range_config**: (TimeRangeConfig or None): Time range configuration for query B. - **distance_function** (DistanceFunction): Distance function to use. for statistics policy: - **query** (Query): Cube.js query. - **time_range_config**: (TimeRangeConfig): Time range configuration for the query. - **cron_expression** (str): Cron expression for policy evaluation. - **condition_above_value** (float or None): Condition above value. - **condition_below_value** (float or None): Condition below value. - **destination_ids** (list of UUID): List of communication channels to get notified through. - **alert_on_status** (AlertOnStatusDirection): Trigger policy action if the value is above/below. - **alert_on_policy_level** (bool): Trigger policy action on a single group/entire groups. - **dataset_id** (str): The dataset this policy is monitoring. - [Get Policy By Id](https://docs.superwise.ai/reference/get_policy.md): Get policy by ID - policy_id (UUID): The ID of the policy. - [Delete policy by ID](https://docs.superwise.ai/reference/delete_policy.md): Delete a specific Policy - **policy_id**: The ID of the policy to be deleted. Raises: PolicyNotFoundException: If the policy with the specified ID is not found. - [Update policy by ID](https://docs.superwise.ai/reference/update_policy.md): Update policy by ID. - **payload** (PolicyUpdate): Required. The updated policy information with: - **name** (str or None): The updated name of the policy. - **data_config**: Configuration relevant to the retrieval of data for this policy: for compare distribution policy: - **query_a** (Query): Cube.js query. - **query_b** (Query): Cube.js query. - **query_a_time_range_config**: (TimeRangeConfig or None): Time range configuration for query A. - **query_b_time_range_config**: (TimeRangeConfig or None): Time range configuration for query B. - **distance_function** (DistanceFunction): Distance function to use. for statistics policy: - **query** (Query): Cube.js query. - **cron_expression** (str or None): The updated cron expression for the policy evaluation. - **condition_above_value** (float or None): The updated condition above value. - **condition_below_value** (float or None): The updated condition below value. - **destination_ids** (list of UUID or None): The updated list of communication channels to get notified through. - **alert_on_status** (AlertOnStatusDirection or None): The updated trigger policy action if the value is above/below. - **alert_on_policy_level** (bool or None): The updated trigger policy action on a single group/entire groups. - **dataset_id** (str or None): The updated dataset this policy is monitoring. - **policy_id** (UUID): Required. The ID of the policy to be updated. - [Trigger policy by ID](https://docs.superwise.ai/reference/trigger_policy.md): Trigger policy by ID. - **policy_id** (UUID): The unique identifier of the policy that needs to be triggered. - [Search Policies](https://docs.superwise.ai/reference/search_policies.md): Search through Policies based on provided filters - [Get Tagged Policies](https://docs.superwise.ai/reference/get_tagged_policies.md): Get all ids tagged by *all* tags. - [Add Policy Tags](https://docs.superwise.ai/reference/add_policy_tags.md): Add tags to policy. - [Delete Policy Tags](https://docs.superwise.ai/reference/delete_policy_tags.md): Delete tags from policy. - [Policy Bulk Action](https://docs.superwise.ai/reference/policy_bulk_action.md): Perform a bulk action on a list of policies. - [archive policy by ID](https://docs.superwise.ai/reference/archive_policy.md) - [unarchive policy by ID](https://docs.superwise.ai/reference/unarchive_policy.md) - [Create Policy Template](https://docs.superwise.ai/reference/create_policy_template.md): Creates a new Policy based on a provided template - [Create Mcp](https://docs.superwise.ai/reference/create_mcp.md): Create a new MCP entity. This endpoint will connect to the MCP server, fetch available tools, and validate that the specified tool_name exists. Parameters: - **name**: MCP name - **url**: MCP server URL - **tool_name**: Name of the specific tool to fetch from MCP server - **network_access**: Network access level (must be 'remote') - **headers**: Optional authentication headers - [List Mcps](https://docs.superwise.ai/reference/list_mcps.md): Get a paginated list of MCP entities. If search is provided, it takes priority over specific filters. By default, soft-deleted MCPs are excluded. Set include_disabled=true to include them. - [Test Mcp Connectivity](https://docs.superwise.ai/reference/test_mcp_connectivity.md): Test MCP server connectivity. This endpoint tests the connectivity to the MCP server using the provided URL and headers. On success, it returns the full list of available tools with their schemas. On failure, it returns an appropriate error status code (400 or 502). Parameters: - **url**: The MCP server URL to test - **headers**: Optional authentication headers - [Get Mcp By Id](https://docs.superwise.ai/reference/get_mcp_by_id.md): Get an MCP entity by ID. By default, returns 404 for soft-deleted MCPs. Set disabled=true to retrieve them. Parameters: - **mcp_id**: The UUID of the MCP entity - **include_disabled**: If true, will return soft-deleted MCPs - [Update Mcp](https://docs.superwise.ai/reference/update_mcp.md): Update an MCP entity. Only the name field can be updated. All other fields are immutable. Parameters: - **mcp_id**: The UUID of the MCP entity - **payload**: Update payload (only name field is allowed) - [Delete Mcp](https://docs.superwise.ai/reference/delete_mcp.md): Soft delete an MCP entity. This endpoint will soft delete the MCP by setting the deleted_at timestamp. Existing agent versions that reference this MCP will continue to work. Parameters: - **mcp_id**: The UUID of the MCP entity - [Get Sources](https://docs.superwise.ai/reference/get_sources.md): Retrieve all sources based on the provided filters. - **name**: Name of the source - **created_by**: Creator of the source - **created_at**: When the source was created - **updated_at**: When the source was last updated - **type**: Type of the source - [Create Source](https://docs.superwise.ai/reference/create_source.md): Create a new source. The SourceCreate model is defined by either the SourceCreateGCS, SourceCreateAzure or SourceCreateS3 classes, based on the source type. Parameters: - **source_id**: UUID of the source. - **payload**: Instance of SourceCreate model which can be any one of the following based on source type: - **SourceCreateGCS** - **type**: Literal, Source Type GCS. - **params**: SourceGCSParams object or None. Parameters for GCS source. - **credentials**: GCPCredentials object or None. Credentials for GCS source. - Validation is applied on the `credentials` field based on the hosting type. - **SourceCreateAzure** - **type**: Literal, Source type AZURE_BLOB_STORAGE. - **params**: SourceAzureParams object. Parameters for Azure source. - **credentials**: AzureCredentials object. Credentials for Azure source. - **SourceCreateS3** - **type**: Literal, Source type S3. - **params**: SourceS3Params object. Parameters for S3 source. - **credentials**: AWSCredentials object. Credentials for AWS source. - [Test Source Connection](https://docs.superwise.ai/reference/test_source_connection.md): Test the connection to a source. - **payload**: Instance of TestSourceConnectionRequest model. - [Get Source](https://docs.superwise.ai/reference/get_source.md): Retrieve a Source based on the given source_id. - **source_id**: UUID of the source - [Delete Source](https://docs.superwise.ai/reference/delete_source.md): Delete a specific source. - **source_id**: UUID of the source - [Update Source](https://docs.superwise.ai/reference/update_source.md): Update an existing source. The SourceUpdate Model is defined by the SourceUpdateGCS or SourceUpdateS3 class, based on the source type. Parameters: - **source_id**: UUID of the source to update. - **payload**: Instance of SourceUpdate model which can be any one of the following based on source type: - **SourceUpdateGCS** - **type**: Literal, Source Type GCS. - **params**: SourceGCSParams object or None. Parameters for GCS source. - **credentials**: GCPCredentials object or None. Credentials for GCS source. - **SourceUpdateS3** - **type**: Literal, Source type S3. - **params**: SourceS3Params object or None. Parameters for S3 source. - **credentials**: AWSCredentials object or None. Credentials for AWS source. - [Get Tags](https://docs.superwise.ai/reference/get_tags.md) - [Create Tag](https://docs.superwise.ai/reference/create_tag.md): Create a new tag. - [Get Tag By Id](https://docs.superwise.ai/reference/get_tag_by_id.md): Get tag by id. - [Patch Tag](https://docs.superwise.ai/reference/patch_tag.md) - [Delete Tag](https://docs.superwise.ai/reference/delete_tag.md): Delete tag. - [Get Model Providers](https://docs.superwise.ai/reference/get_model_providers.md): Get model providers list with pagination. - [Create Model Provider](https://docs.superwise.ai/reference/create_model_provider.md): Create a new model provider. - [Get Prebuilt Provider Status](https://docs.superwise.ai/reference/get_prebuilt_provider_status.md) - [Get Model Provider By Id](https://docs.superwise.ai/reference/get_model_provider_by_id.md): Get model provider by id. - [Patch Model Provider](https://docs.superwise.ai/reference/patch_model_provider.md): Patch a model provider. - [Delete Model Provider](https://docs.superwise.ai/reference/delete_model_provider.md): Delete a model provider. - [Delete All Tags](https://docs.superwise.ai/reference/delete_all_tags.md): Delete all tags for the tenant. - [Delete Tenant](https://docs.superwise.ai/reference/delete_tenant.md): Delete tenant endpoint. - [Get Sentinels](https://docs.superwise.ai/reference/get_sentinels.md) - [Create Sentinel](https://docs.superwise.ai/reference/create_sentinel.md) - [Search Sentinels](https://docs.superwise.ai/reference/search_sentinels.md) - [Get Sentinel By Id](https://docs.superwise.ai/reference/get_sentinel_by_id.md) - [Patch Sentinel](https://docs.superwise.ai/reference/patch_sentinel.md) - [Delete Sentinel](https://docs.superwise.ai/reference/delete_sentinel.md) - [Sentinel Heartbeat](https://docs.superwise.ai/reference/sentinel_heartbeat.md) - [get_sentinel_metrics](https://docs.superwise.ai/reference/get_sentinel_metrics.md) - [get_sentinel_metrics_by_id](https://docs.superwise.ai/reference/get_sentinel_metrics_by_id.md) - [Verify Dataset Schema](https://docs.superwise.ai/reference/verify_sentinel_dataset_schema.md) - [Get Sentinel Guardrail Metrics](https://docs.superwise.ai/reference/get_sentinel_guardrail_metrics.md) - [Submit Issue Report](https://docs.superwise.ai/reference/submit_issue_report.md): Report an issue (Bug / Error, Account Issue, Billing, Feature request). Accepts ``multipart/form-data``. Uploaded files are emailed to the reporter as MIME attachments and described (name, type, size) in the admin Teams message. When object storage is configured they are also uploaded there so the Teams message can link to them; they are never persisted to the database or local disk. - **category** (str): Required. One of `bug`, `account`, `billing`, `feature_request`. - **description** (str): Required. 1–1000 characters. - **reporter_name** (str): Required. Display name of the logged-in user filing the issue. - **reporter_email** (str): Required. Email of the logged-in user; the summary email is sent here. - **page_url** (str): Optional. URL of the current page/route where the issue occurred. - **device** (str): Optional. Reporter's device (environment context). - **operating_system** (str): Optional. Reporter's operating system (environment context). - **browser_version** (str): Optional. Reporter's browser and version (environment context). - **screen_resolution** (str): Optional. Reporter's screen resolution (environment context). - **network_status** (str): Optional. Network status at report time (technical context). - **client_timestamp** (str): Optional. Client-side timestamp when the issue occurred (technical context). - **attachments** (list[UploadFile]): Optional. Screenshots or short screen recordings; count, size, and MIME type limits are enforced via configuration. - [Get Issue Attachment](https://docs.superwise.ai/reference/get_issue_attachment.md): Stream an issue-report attachment from object storage, scoped to the caller's tenant. ## Changelog - [Version 1.37.0](https://docs.superwise.ai/changelog/version-1370.md) - [Version 1.36.0](https://docs.superwise.ai/changelog/version-1360.md) - [Version 1.35.0](https://docs.superwise.ai/changelog/version-1350.md) - [Version 1.34.0](https://docs.superwise.ai/changelog/version-1340.md) - [Version 1.33.1](https://docs.superwise.ai/changelog/version-1331.md) - [Version 1.33.0](https://docs.superwise.ai/changelog/version-1330.md) - [Version 1.32.0](https://docs.superwise.ai/changelog/version-1320.md) - [Version 1.31.0](https://docs.superwise.ai/changelog/version-1310.md) - [Version 1.30.3](https://docs.superwise.ai/changelog/version-1303.md) - [Version 1.30.2](https://docs.superwise.ai/changelog/version-1302.md)