Delete LLM Provider

Before You Begin

🔗 Use the GraphQL Playground to execute the mutations in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token.
2. Permissions: You must have permissions to manage AI providers in the organization.
3. Organization UUID: The UUID of the organization where the provider exists.
4. LLM Provider ID: The ID of the provider configuration you wish to delete. You can get this from the llmProvidersByOrganization query.

Step 1: Execute the Mutation

This mutation permanently removes an existing LLM provider configuration from an organization. This action cannot be undone.

mutation {
  deleteLlmProvider(
    input: {
      id: "27"
      organizationUuid: "org-uuid-example"
    }
  ) {
    success
  }
}

Arguments

• id (ID, required): The ID of the LLM provider configuration to delete.
• organizationUuid (String, required): The UUID of the organization from which to delete the provider.

Response Fields

• success: A boolean value that is true if the provider was deleted successfully.

Example Response

{
  "data": {
    "deleteLlmProvider": {
      "success": true
    }
  }
}

Additional Notes

• If the mutation fails due to an invalid id, incorrect organizationUuid, or lack of permissions, an error will be returned.
• Warning: Deleting a provider is a permanent action.
• If you attempt to delete a provider that is currently set as the active provider for an assistant or the organization, the mutation may fail or it may leave the owner without an active provider. It is recommended to switch to a different active provider before deleting the current one.

This mutation provides a definitive way to remove LLM provider configurations that are no longer needed.