Workspace Settings SDK Reference

Workspace Settings

Retrieve a Workspace Setting

Returns the current settings for the authenticated workspace: its read-only key/slug, display name, the enforce-enabled-models flag, and the workspace-default PII redaction plugin configuration.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_settings.get()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSettings.get();

  console.log(result);
}

run();

Show Response

{
    "settings": {
        "key": str,
        "display_name": str,
        "enforce_enabled_models": bool,
        "pii_redaction": {  # optional
            "enabled": bool,
            "config": {  # optional
                "language": Optional[str],
                "entities": List[str],  # optional
                "on_failure": Optional[str],
                "threshold": Optional[float],
            },
        },
    },
}

{
  settings: {
    key: string;
    displayName: string;
    enforceEnabledModels: boolean;
    piiRedaction?: {
      enabled: boolean;
      config?: {
        language?: string;
        entities?: string[];
        onFailure?: string;
        threshold?: number;
      };
    };
  };
}

Update a Workspace Setting

Partially updates workspace settings. Every field is optional; an omitted field is left unchanged. Provide display_name to rename the workspace, enforce_enabled_models to toggle model enforcement, or pii_redaction to replace the workspace-default PII redaction plugin configuration.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.workspace_settings.update()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.workspaceSettings.update({});

  console.log(result);
}

run();

Show Parameters

{
    "display_name": Optional[str],
    "enforce_enabled_models": Optional[bool],
    "pii_redaction": {  # optional
        "enabled": bool,  # required
        "config": {  # optional
            "language": Optional[str],
            "entities": List[str],  # optional
            "on_failure": Optional[str],
            "threshold": Optional[float],
        },
    },
}

{
  displayName?: string;
  enforceEnabledModels?: boolean;
  piiRedaction?: {
    enabled: boolean;  // required
    config?: {
      language?: string;
      entities?: string[];
      onFailure?: string;
      threshold?: number;
    };
  };
}

Show Response

{
    "settings": {
        "key": str,
        "display_name": str,
        "enforce_enabled_models": bool,
        "pii_redaction": {  # optional
            "enabled": bool,
            "config": {  # optional
                "language": Optional[str],
                "entities": List[str],  # optional
                "on_failure": Optional[str],
                "threshold": Optional[float],
            },
        },
    },
}

{
  settings: {
    key: string;
    displayName: string;
    enforceEnabledModels: boolean;
    piiRedaction?: {
      enabled: boolean;
      config?: {
        language?: string;
        entities?: string[];
        onFailure?: string;
        threshold?: number;
      };
    };
  };
}

⌘I

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Enterprise APIs (coming soon)