Skip to main content
Version: Beta

AiWorkflow

description

Unified AI Workflow type that represents both system templates and user-custom workflows. Use the 'workflowType' field to distinguish between them.

SYSTEM workflows: Pre-defined templates available to users based on persona/access. USER_CUSTOM workflows: User-created custom workflows with optional scheduling.

type AiWorkflow {
id: ID!
workflowType: AiWorkflowType!
name: String!
description: String
artifactTypes: [AiWorkflowArtifactType!]!
executionMode: AiWorkflowExecutionMode!
documentSearchCriteria: AiWorkflowTemplateSearchCriteria
createdBy: String
version: Int!
createdAt: String!
updatedAt: String!
}

Fields

AiWorkflow.id ● ID! non-null scalar graph-ql-types

Unique identifier for the workflow @exposed(scopes: ['enterprise-only'])

AiWorkflow.workflowType ● AiWorkflowType! non-null enum graph-ql-types

Type of workflow (SYSTEM or USER_CUSTOM) @exposed(scopes: ['enterprise-only'])

AiWorkflow.name ● String! non-null scalar graph-ql-types

Name of the workflow @exposed(scopes: ['enterprise-only'])

AiWorkflow.description ● String scalar graph-ql-types

Detailed description of what this workflow does @exposed(scopes: ['enterprise-only'])

AiWorkflow.artifactTypes ● [AiWorkflowArtifactType!]! non-null enum graph-ql-types

Types of artifacts this workflow can generate (reports, slides, etc.) @exposed(scopes: ['enterprise-only'])

AiWorkflow.executionMode ● AiWorkflowExecutionMode! non-null enum graph-ql-types

Execution mode determining processing depth and speed @exposed(scopes: ['enterprise-only'])

AiWorkflow.documentSearchCriteria ● AiWorkflowTemplateSearchCriteria object graph-ql-types

Search criteria for document filtering @exposed(scopes: ['enterprise-only'])

AiWorkflow.createdBy ● String scalar graph-ql-types

ID of the user who created this workflow @exposed(scopes: ['enterprise-only'])

AiWorkflow.version ● Int! non-null scalar graph-ql-types

Version number for workflow versioning and updates @exposed(scopes: ['enterprise-only'])

AiWorkflow.createdAt ● String! non-null scalar graph-ql-types

ISO timestamp when the workflow was created @exposed(scopes: ['enterprise-only'])

AiWorkflow.updatedAt ● String! non-null scalar graph-ql-types

ISO timestamp when the workflow was last modified @exposed(scopes: ['enterprise-only'])

Member Of

AiWorkflowsResponse object