Use Case Template

Title: Enable or Disable AI features

Before You Begin

Include universal prerequisites and tools here.

• GraphQL Playground:
  🔗 All examples should be run in the GraphQL Playground.
  ➡️ New to GraphQL? Review the Playground Basics Guide.
• Authentication:
  🛠️ Use Service Account tokens (Personal Access Tokens are deprecated).

Prerequisites

• Super Admin role on the Organization.
• Organization UUID.

Step 1. Find the Organization ID

Find the organization UUID.

You can retrieve it using this query:

{
  organization(id: "<ORGANIZATION_ID>") {
    uuid
  }
}

The organization ID can be found on the home page url: https://app.pipefy.com/organizations/<ORGANIZATION_ID>

Step 2. Execute the mutation

mutation {
  updateAiSettings(
    input: {
      organizationUuid: <ORGANIZATION_UUID>,
      aiEnabled: true,
      aiAssistantsEnabled: false,
      pipeAiAgentsEnabled: false
    }
  ) {
    success
    organizationPreferences {
      aiEnabled
      aiAssistantsEnabled
      pipeAiAgentsEnabled
    }
  }
}

Input Explanation:

• aiEnabled: Enables all AI features in the product.
• aiAssistantsEnabled: Enables the AI assistants. Find more about them here
• pipeAiAgentsEnabled: Enables the AI agents inside the Pipe. Find more about them here

Sample Response:

{
  "data": {
    "updateAiSettings": {
      "success": true,
      "organizationPreferences": {
        "aiEnabled": true,
        "aiAssistantsEnabled": false,
        "pipeAiAgentsEnabled": false
      }
    }
  }
}

The response includes a success field and the field organizationPreferences, that contains all the updated AI Settings.

Key Notes

You can't set the fields aiAssistantsEnabled and pipeAiAgentsEnabled to true if the field aiEnabled is set to false, as it control AI features in general.