> ## Documentation Index > Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create Message > Creates a new Message. Messages are individual communications within a channel. ## OpenAPI ````yaml post /api/messages openapi: 3.0.1 info: title: Kodexa AI description: >- The Kodexa platform API provides programmatic access to document processing, intelligent automation, and data extraction capabilities. Use this API to manage organizations, projects, document stores, taxonomies, assistants, and processing pipelines. All endpoints require authentication via API key, Bearer token, or Basic auth. version: 8.0.0 license: name: Commercial url: https://kodexa.ai servers: - url: https://platform.kodexa.ai description: Production - url: http://localhost:8080 description: Local development security: - x-api-key: [] - bearerAuth: [] tags: - name: AI Gateway - name: AccessTokens description: Manage API access tokens for programmatic authentication. - name: Account description: Account management endpoints for the authenticated user. - name: Activities - name: ActivityDocumentFamilies - name: ActivityPlans - name: Agent Runtimes description: Manage agent runtime definitions backed by AWS Bedrock AgentCore. - name: Agent Sessions description: View and manage stateful conversation sessions within agent runtimes. - name: Agents description: Manage agents — instantiated agent runtimes within an org+project. - name: Analytics - name: Applied Knowledge description: Manage applied knowledge instances used during document processing. - name: Applied Knowledge Sets description: Manage applied knowledge set configurations. - name: AssistantConnection description: Manage connections between assistants and external services. - name: Assistants description: Manage AI assistants that process and analyze documents within a project. - name: Batch Updates description: Batch document update operations for efficient bulk processing. - name: Channel description: Manage messaging channels for real-time communication within the platform. - name: Content Exception description: View and manage content exceptions that occur during document processing. - name: Content Object description: >- Manage content objects — individual files or processing results within a document family. - name: Credit Transactions description: View and manage credit transactions for organization billing. - name: Data Definitions description: >- Manage data definitions (taxonomies) that define document structure and extraction rules. - name: Data Forms description: Manage data form definitions for structured data capture from documents. - name: Data Stores description: Manage data stores for structured data storage. - name: Document Assignments description: Manage document assignments linking document families to users for review. - name: Document Family Statistics description: View statistics about document families including processing metrics. - name: Document Statuses description: >- Manage document status definitions for tracking document processing states. - name: Document Stores description: >- Manage document stores — containers for organizing and processing documents within a project. - name: Document Transitions description: Track state transitions of documents through processing stages. - name: DocumentFamilies description: >- Manage document families — groups of related content objects representing a single logical document. - name: Events description: >- Manage and publish platform events for real-time notifications and integrations. - name: Execution Slices description: View execution slice details within pipeline executions. - name: Executions description: View and manage processing execution records. - name: Intakes description: >- Manage intake configurations for ingesting documents from external sources. - name: Job Document Family Interactions description: View interactions between scheduled jobs and document families. - name: Knowledge Clause Features description: Manage features within knowledge clauses. - name: Knowledge Clauses description: Manage knowledge clauses within knowledge items. - name: Knowledge Feature Types description: Manage knowledge feature type definitions. - name: Knowledge Features description: >- Manage knowledge features representing specific data points within knowledge items. - name: Knowledge Item Types description: Manage knowledge item type definitions. - name: Knowledge Items description: Manage individual knowledge items within knowledge sets. - name: Knowledge Set Snapshots description: Manage snapshots of knowledge sets for versioning and comparison. - name: Knowledge Set Sources description: Manage source references for knowledge sets. - name: Knowledge Sets description: >- Manage knowledge sets — collections of extracted knowledge used for AI-assisted processing. - name: Labels description: >- Manage labels used for categorizing and tagging resources within an organization. - name: Linked Deltas description: Manage linked deltas representing changes between document versions. - name: Messages description: Manage messages within channels. - name: Model Costs - name: Module Runtimes description: Manage module runtime definitions within the orchestrator. - name: Modules - name: Orchestrator Modules description: Manage processing modules for orchestrator pipelines. - name: Organizations description: >- Manage organizations — the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization. - name: Permissions - name: Platform Configuration description: Manage platform-wide configuration settings. - name: Platform Overview description: Platform configuration and overview endpoints. - name: Product Groups description: Manage product groups that bundle related products together. - name: Product Overview description: Browse and manage products available on the Kodexa platform. - name: Product Subscriptions description: Manage product subscriptions linking organizations to products. - name: ProductProjectTemplates description: >- Manage product project templates that define default project configurations. - name: Project Resources - name: Project Status description: Manage project status definitions for tracking project lifecycle. - name: Project Templates description: Manage project templates that define reusable project configurations. - name: Projects description: >- Manage projects within an organization. Projects group related document stores, assistants, tasks, and processing pipelines. - name: Prompts description: Manage prompt templates used by AI assistants for document processing. - name: Purge Items description: Manage purge items for scheduled content cleanup. - name: Recent Executions description: View recent execution history for document processing. - name: Resource Resolution - name: Role Permissions - name: Roles - name: Scheduled Job Executions description: View execution history and results of scheduled jobs. - name: Scheduled Job Schedules description: Manage schedule definitions (cron expressions) for scheduled jobs. - name: Scheduled Jobs description: >- Manage scheduled jobs for automated document processing on a recurring basis. - name: Service Bridges - name: Sessions description: Manage processing sessions for document operations. - name: Step Executions description: View step-level execution details within pipeline executions. - name: Tag Metadata description: Manage tag metadata definitions for document labeling and categorization. - name: Task Groups - name: Task Statuses description: Manage task status definitions for tracking task workflow states. - name: TaskActivity description: Track activity history on tasks, including status changes and comments. - name: TaskDocumentFamilies description: Manage the association between tasks and document families. - name: TaskGroupHistory - name: TaskTemplates description: Manage task templates that define reusable task configurations. - name: Tasks description: >- Manage tasks for document review workflows. Tasks have assignees, statuses, due dates, and can contain document families. - name: Team Members description: Manage team membership assignments. - name: Team Org Assignments - name: Team Project Assignments - name: Teams description: Manage teams for collaborative access control within projects. - name: Triggers - name: Users description: Manage platform user accounts. - name: Workspaces description: Manage workspaces for organizing project resources. externalDocs: description: Kodexa Developer Documentation url: https://developer.kodexa.ai paths: /api/messages: post: tags: - Messages summary: Create Message description: >- Creates a new Message. Messages are individual communications within a channel. operationId: createMessage requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Message' responses: '201': description: Created Message content: application/json: schema: $ref: '#/components/schemas/Message' '400': description: Bad Request — the request body or parameters are invalid. '401': description: Unauthorized — authentication is required. '403': description: Forbidden — the authenticated user does not have permission. '409': description: Conflict — a resource with the same unique key already exists. components: schemas: Message: type: object properties: assistant: $ref: '#/components/schemas/Assistant' nullable: true assistantId: type: string nullable: true block: $ref: '#/components/schemas/MessageBlock' changeSequence: type: integer format: int32 description: Optimistic locking version number. channel: $ref: '#/components/schemas/Channel' nullable: true channelId: type: string nullable: true content: type: string context: $ref: '#/components/schemas/MessageContext' createdOn: type: string format: date-time description: Timestamp when the message was created. eventExpiresAt: type: string format: date-time nullable: true feedback: $ref: '#/components/schemas/MessageFeedback' id: type: string description: Unique identifier (UUID) for the message. messageSequence: type: integer format: int64 messageType: type: string enum: - TEXT - BLOCK - TEMPLATE updatedOn: type: string format: date-time description: Timestamp when the message was last updated. user: $ref: '#/components/schemas/PlatformUser' nullable: true userId: type: string nullable: true uuid: type: string description: Secondary UUID identifier. description: A message is an individual communication within a channel. Assistant: type: object properties: active: type: boolean nullable: true assistantRole: type: string changeSequence: type: integer format: int32 description: Optimistic locking version number. chatEnabled: type: boolean nullable: true color: type: string createdOn: type: string format: date-time description: Timestamp when the assistant was created. deleted: type: boolean description: type: string id: type: string description: Unique identifier (UUID) for the assistant. example: e4567890-12ab-cdef-3456-789012abcdef name: type: string description: Display name of the assistant. example: Invoice Extractor options: $ref: '#/components/schemas/AssistantOptions' priorityHint: type: integer format: int32 nullable: true project: $ref: '#/components/schemas/Project' nullable: true projectId: type: string nullable: true runOnExistingContent: type: boolean nullable: true showInTraining: type: boolean nullable: true slug: type: string description: URL-friendly identifier for the assistant. example: invoice-extractor subscription: type: string testOptions: type: object additionalProperties: type: object updatedOn: type: string format: date-time description: Timestamp when the assistant was last updated. uuid: type: string description: Secondary UUID identifier. validationErrors: $ref: '#/components/schemas/ValidationResults' description: >- An assistant is an AI-powered processor that analyzes and extracts data from documents within a project. MessageBlock: type: object properties: children: type: array items: $ref: '#/components/schemas/MessageBlock' id: type: string properties: type: object additionalProperties: {} type: type: string Channel: type: object properties: changeSequence: type: integer format: int32 description: Optimistic locking version number. createdOn: type: string format: date-time description: Timestamp when the channel was created. id: type: string description: Unique identifier (UUID) for the channel. isPrivate: type: boolean kapEnabled: type: boolean name: type: string description: Display name of the channel. project: $ref: '#/components/schemas/Project' nullable: true projectId: type: string nullable: true suppressEvents: type: boolean task: $ref: '#/components/schemas/Task' nullable: true taskId: type: string nullable: true updatedOn: type: string format: date-time description: Timestamp when the channel was last updated. uuid: type: string description: Secondary UUID identifier. description: >- A channel provides real-time messaging and communication within the platform. MessageContext: type: object properties: activeData: type: array items: type: object additionalProperties: {} contentObjectId: type: string documentFamilyId: type: string feedbackOption: $ref: '#/components/schemas/MessageFeedbackResponse' nullable: true messageTemplate: $ref: '#/components/schemas/MessageTemplate' nullable: true page: type: integer format: int32 nullable: true selectedNodeUuids: type: array items: type: string storeRef: type: string taskId: $ref: '#/components/schemas/MessageFeedbackResponse' nullable: true taxonomyRefs: type: array items: type: string workspaceAssistantName: type: string MessageFeedback: type: object properties: options: type: array items: $ref: '#/components/schemas/MessageFeedbackOption' rating: type: integer format: int32 PlatformUser: type: object properties: active: type: boolean bio: type: string businessGroup: type: string changeSequence: type: integer format: int32 description: Optimistic locking version number. createdOn: type: string format: date-time description: Timestamp when the user was created. email: type: string firstName: type: string groupsJson: type: string id: type: string description: Unique identifier (UUID) for the user. image: type: string isExternallyManaged: type: boolean lastName: type: string preferences: $ref: '#/components/schemas/UserPreferences' rolesJson: type: string searchText: type: string security: $ref: '#/components/schemas/UserRoles' showDeveloperTools: type: boolean title: type: string updatedOn: type: string format: date-time description: Timestamp when the user was last updated. userStorage: $ref: '#/components/schemas/UserStorage' userType: type: string uuid: type: string description: Secondary UUID identifier. description: A platform user represents a user account in the Kodexa platform. AssistantOptions: type: object properties: agentRuntimeId: type: string nullable: true description: Agent runtime ID for agentic assistants. complete_label: type: string nullable: true moduleRefs: type: array items: type: string description: Module references available to agentic assistants. pipeline: $ref: '#/components/schemas/PipelineConfig' nullable: true description: Pipeline configuration for robotic assistants. prompt: type: string nullable: true description: System prompt for agentic assistants. taxonomies: type: array items: type: string description: Taxonomy references used by this assistant. Project: type: object properties: changeSequence: type: integer format: int32 description: Optimistic locking version number. color: type: string description: Display color for the project (max 25 characters). example: '#4A90D9' createdOn: type: string format: date-time description: Timestamp when the project was created. dataFlow: $ref: '#/components/schemas/ProjectDataFlow' description: Project data flow configuration. description: type: string description: Human-readable description of the project. example: Automated invoice processing pipeline. documentStatuses: type: array items: $ref: '#/components/schemas/DocumentStatus' id: type: string description: Unique identifier (UUID) for the project. example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 memory: $ref: '#/components/schemas/ProjectMemory' description: Project-level memory and configuration. name: type: string description: Display name of the project. example: Invoice Processing notes: type: string description: Free-form notes about the project. options: $ref: '#/components/schemas/ProjectOptions' description: Project options and settings. organization: $ref: '#/components/schemas/Organization' nullable: true organizationId: type: string nullable: true description: ID of the organization this project belongs to. owner: $ref: '#/components/schemas/PlatformUser' nullable: true ownerId: type: string nullable: true description: ID of the user who owns this project. projectTemplateRef: type: string description: Reference to the project template used to create this project. searchText: type: string slug: type: string description: >- URL-friendly identifier. Automatically lowercased. Pattern: ^[a-z0-9-]+$ example: invoice-processing status: $ref: '#/components/schemas/ProjectStatus' nullable: true statusId: type: string nullable: true description: ID of the current project status. statusType: type: string description: 'Project lifecycle state: ACTIVE, ARCHIVED, or PENDING_DELETE.' example: ACTIVE templateArticleId: type: string updatedOn: type: string format: date-time description: Timestamp when the project was last updated. uuid: type: string description: Secondary UUID identifier. example: 7c9e667974254de944be07fc1f90ae7 description: >- A project groups related document stores, assistants, tasks, and processing pipelines within an organization. ValidationResults: type: object properties: instances: type: array items: $ref: '#/components/schemas/ProjectsValidationError' Task: type: object properties: assignee: $ref: '#/components/schemas/PlatformUser' nullable: true assigneeId: type: string nullable: true description: ID of the user assigned to this task. changeSequence: type: integer format: int32 description: Optimistic locking version number. completedDate: type: string format: date-time nullable: true description: Date when the task was completed. createdByActivityId: type: string nullable: true createdOn: type: string format: date-time description: Timestamp when the task was created. deleteUserEmail: type: string description: Email of the user who deleted the task. deleteUserId: type: string description: ID of the user who deleted the task. deleted: type: boolean description: Whether the task has been soft-deleted. deletedDate: type: string format: date-time nullable: true description: Timestamp when the task was soft-deleted. description: type: string description: Detailed description of the task. example: Review and validate all Q4 2025 invoices. dueDate: type: string format: date-time nullable: true description: Due date for the task. id: type: string description: Unique identifier (UUID) for the task. example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 locked: type: boolean description: Whether the task is locked for editing. metadata: $ref: '#/components/schemas/TaskMetadata' description: Task metadata including custom fields. parentTask: $ref: '#/components/schemas/Task' nullable: true parentTaskId: type: string nullable: true description: ID of the parent task (for sub-tasks). plan: $ref: '#/components/schemas/Activity' nullable: true priority: type: integer format: int32 nullable: true description: Priority level of the task (lower number = higher priority). example: 1 project: $ref: '#/components/schemas/Project' nullable: true projectId: type: string nullable: true description: ID of the project this task belongs to. properties: type: object additionalProperties: type: object description: Task properties for UI state and configuration. searchText: type: string description: Full-text searchable representation of the task. signal: $ref: '#/components/schemas/TaskSignal' description: Signal from human reviewer for plan-aware task completion. statusSlug: type: string nullable: true taskActivities: type: array items: $ref: '#/components/schemas/TaskActivity' taskGroupId: type: string nullable: true team: $ref: '#/components/schemas/Team' nullable: true teamId: type: string nullable: true template: $ref: '#/components/schemas/TaskTemplate' nullable: true templateId: type: string nullable: true description: ID of the task template used. title: type: string description: Title of the task. example: Review Q4 invoices updatedOn: type: string format: date-time description: Timestamp when the task was last updated. uuid: type: string description: Secondary UUID identifier. description: >- A task represents a unit of work in a document review workflow, with an assignee, status, and due date. MessageFeedbackResponse: type: object properties: id: type: string properties: type: object additionalProperties: {} MessageTemplate: type: object properties: id: type: string properties: type: object additionalProperties: {} MessageFeedbackOption: type: object properties: color: type: string description: type: string icon: type: string id: type: string label: type: string options: type: array items: {} type: type: string value: type: string UserPreferences: type: object properties: showOnboarding: type: boolean nullable: true showScrollbars: type: boolean nullable: true showWelcomeMessage: type: boolean nullable: true UserRoles: type: object properties: roles: type: array items: type: string UserStorage: type: object properties: favoriteLinks: type: array items: $ref: '#/components/schemas/FavoriteLink' PipelineConfig: type: object properties: steps: type: array items: $ref: '#/components/schemas/PipelineStepConfig' ProjectDataFlow: type: object properties: edges: type: array items: $ref: '#/components/schemas/DataFlowEdge' nodes: type: array items: $ref: '#/components/schemas/DataFlowNode' viewPort: $ref: '#/components/schemas/FlowViewPort' nullable: true DocumentStatus: type: object properties: changeSequence: type: integer format: int32 color: type: string createdOn: type: string format: date-time icon: type: string id: type: string project: $ref: '#/components/schemas/Project' nullable: true projectId: type: string nullable: true slug: type: string status: type: string statusType: type: string enum: - UNRESOLVED - RESOLVED updatedOn: type: string format: date-time uuid: type: string description: >- A document status defines a named state for tracking document processing progress. ProjectMemory: type: object properties: changeSequence: type: integer format: int32 nullable: true orderedDashboards: type: array items: type: string recentFilters: type: object additionalProperties: type: array items: type: string recentQueries: type: object additionalProperties: type: array items: type: string ProjectOptions: type: object properties: companion: $ref: '#/components/schemas/CompanionConfig' nullable: true dataOptions: type: array items: $ref: '#/components/schemas/Option' dataProperties: type: object additionalProperties: {} executionPolicy: $ref: '#/components/schemas/ExecutionPolicy' nullable: true groupTaxonTypeFeatures: type: object additionalProperties: {} options: type: array items: $ref: '#/components/schemas/Option' properties: type: object additionalProperties: {} taskOptions: $ref: '#/components/schemas/ProjectTaskOptions' nullable: true taxonTypeFeatures: type: object additionalProperties: {} Organization: type: object properties: archived: type: boolean nullable: true authGroupLink: $ref: '#/components/schemas/AuthGroupLink' changeSequence: type: integer format: int32 description: Optimistic locking version number, incremented on each update. createdOn: type: string format: date-time description: Timestamp when the organization was created. defaultToPrivateTemplates: type: boolean description: Whether new templates default to private access. description: type: string description: Human-readable description of the organization. example: Document processing organization for Acme Corp. enterpriseOrganization: type: boolean nullable: true description: Whether this is an enterprise-tier organization. features: type: object additionalProperties: type: object description: Feature flags enabled for the organization. hasImage: type: boolean description: Whether the organization has a profile image. id: type: string description: Unique identifier (UUID) for the organization. example: 550e8400-e29b-41d4-a716-446655440000 memory: $ref: '#/components/schemas/OrganizationMemory' description: Organization-level memory and configuration. name: type: string description: Display name of the organization. example: Acme Corp organizationStatus: type: string description: Current status of the organization (e.g., ACTIVE, SUSPENDED). example: ACTIVE properties: type: object additionalProperties: type: object description: Arbitrary key-value properties for the organization. publicAccess: type: boolean description: Whether the organization is publicly visible. searchText: type: string description: Full-text searchable representation of the organization. slug: type: string description: >- URL-friendly identifier, 3-100 characters. Automatically lowercased. Pattern: ^[a-z0-9-]+$ example: acme-corp stripeCustomerId: type: string supportAccess: type: boolean description: Whether Kodexa support has been granted access. supportAccessExpiresAt: type: string format: date-time nullable: true description: When support access expires. updatedOn: type: string format: date-time description: Timestamp when the organization was last updated. uuid: type: string description: Secondary UUID identifier. example: 550e8400e29b41d4a716446655440000 description: >- An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization. ProjectStatus: type: object properties: changeSequence: type: integer format: int32 color: type: string createdOn: type: string format: date-time icon: type: string id: type: string organization: $ref: '#/components/schemas/Organization' nullable: true organizationId: type: string nullable: true production: type: boolean status: type: string updatedOn: type: string format: date-time uuid: type: string description: A project status defines a named state for tracking project lifecycle. ProjectsValidationError: type: object properties: description: type: string message: type: string option: type: string TaskMetadata: type: object properties: actions: type: array items: $ref: '#/components/schemas/TaskTemplateAction' dataProperties: type: object additionalProperties: {} Activity: type: object properties: activityPlanId: type: string nullable: true badges: type: object changeSequence: type: integer format: int32 completedOn: type: string format: date-time nullable: true completedWorkUnits: type: integer format: int32 nullable: true createdOn: type: string format: date-time currentSequence: type: integer format: int32 nullable: true deleteUserEmail: type: string deleteUserId: type: string deleted: type: boolean deletedDate: type: string format: date-time nullable: true description: type: string nullable: true errorDetails: type: string nullable: true failedWorkUnits: type: integer format: int32 nullable: true id: type: string inputs: type: object lifecycleState: type: string metadata: type: object organization: $ref: '#/components/schemas/Organization' nullable: true organizationId: type: string nullable: true parentActivityId: type: string nullable: true priority: type: integer format: int32 projectId: type: string nullable: true replacedByActivityId: type: string nullable: true runningWorkUnits: type: integer format: int32 nullable: true startedByIntakeId: type: string nullable: true startedByTriggerId: type: string nullable: true startedOn: type: string format: date-time nullable: true steps: type: array items: $ref: '#/components/schemas/Step' title: type: string nullable: true totalWorkUnits: type: integer format: int32 nullable: true triggerKind: type: string triggerMetadata: type: object updatedOn: type: string format: date-time uuid: type: string version: type: integer format: int32 nullable: true TaskSignal: type: object properties: metadata: type: object additionalProperties: {} notes: type: string outcome: type: string enum: - APPROVED - REJECTED - NEEDS_REWORK - ESCALATED requestedItems: type: array items: type: object additionalProperties: {} TaskActivity: type: object properties: changeSequence: type: integer format: int32 content: type: string createdOn: type: string format: date-time detail: $ref: '#/components/schemas/TaskActivityDetail' id: type: string searchText: type: string task: $ref: '#/components/schemas/Task' nullable: true taskId: type: string nullable: true updatedOn: type: string format: date-time user: type: object userId: type: string nullable: true uuid: type: string description: >- A task activity records an event in the task's history, such as status changes or comments. Team: type: object properties: changeSequence: type: integer format: int32 createdOn: type: string format: date-time description: type: string id: type: string name: type: string organization: $ref: '#/components/schemas/Organization' nullable: true organizationId: type: string nullable: true searchText: type: string slug: type: string updatedOn: type: string format: date-time uuid: type: string description: >- A team groups users together for collaborative access control within projects. TaskTemplate: type: object properties: changeSequence: type: integer format: int32 createdOn: type: string format: date-time deprecated: type: boolean nullable: true description: type: string id: type: string initialStatusSlug: type: string nullable: true metadata: $ref: '#/components/schemas/TaskTemplateMetadata' name: type: string organizationId: type: string slug: type: string template: type: boolean updatedOn: type: string format: date-time uuid: type: string description: >- A task template defines a reusable task configuration with default values. FavoriteLink: type: object properties: link: type: string PipelineStepConfig: type: object properties: conditional: type: string executionPolicy: $ref: '#/components/schemas/ExecutionPolicy' nullable: true name: type: string options: type: object additionalProperties: {} ref: type: string stepType: type: string DataFlowEdge: type: object properties: id: type: string properties: type: object additionalProperties: {} source: type: string target: type: string DataFlowNode: type: object properties: dimensions: $ref: '#/components/schemas/NodeDimensions' nullable: true id: type: string parentId: type: string position: $ref: '#/components/schemas/NodePosition' nullable: true properties: type: object additionalProperties: {} type: type: string FlowViewPort: type: object properties: x: type: number format: double 'y': type: number format: double zoom: type: number format: double CompanionConfig: type: object properties: agentRuntimeRef: type: string nullable: true moduleRefs: type: array items: type: string prompt: type: string nullable: true Option: type: object properties: aliases: type: array items: type: string default: {} description: type: string developerOnly: type: boolean nullable: true displayProperties: type: object additionalProperties: {} falseLabel: type: string featureFlag: type: string groupOptions: type: array items: $ref: '#/components/schemas/Option' hint: type: string label: type: string listDescription: type: string listLabel: type: string listType: type: string name: type: string overviewMarkdown: type: string possibleValues: type: array items: $ref: '#/components/schemas/PossibleValue' properties: type: object additionalProperties: {} required: type: boolean nullable: true showIf: type: string showOnPopup: type: boolean nullable: true subType: type: string supportArticle: type: string tabName: type: string type: type: string ExecutionPolicy: type: object properties: backoffBaseSeconds: type: integer format: int32 nullable: true backoffStrategy: type: string nullable: true maxAttempts: type: integer format: int32 nullable: true onExhausted: type: string nullable: true timeoutSeconds: type: integer format: int32 nullable: true ProjectTaskOptions: type: object properties: showNewTask: type: boolean showTakeNext: type: boolean AuthGroupLink: type: object properties: authGroup: type: string OrganizationMemory: type: object properties: orderedDashboards: type: array items: type: string TaskTemplateAction: type: object properties: label: type: string properties: type: object additionalProperties: {} type: type: string uuid: type: string Step: type: object properties: activityId: type: string nullable: true agentId: type: string nullable: true agentRuntimeId: type: string nullable: true agentSessionId: type: string nullable: true approvalCriteria: type: object approvalOutcome: type: string nullable: true approverRole: type: string nullable: true bridgeActions: type: object bridgeResult: type: object bypass: type: boolean changeSequence: type: integer format: int32 childTaskId: type: string nullable: true completedActionUuid: type: string nullable: true completedDocFamilyIds: type: object completedOn: type: string format: date-time nullable: true conditionExpression: type: object createdOn: type: string format: date-time currentDocFamilyId: type: string nullable: true disableCache: type: boolean nullable: true endpointName: type: string nullable: true enrichment: type: object errorDetails: type: object executionId: type: string nullable: true id: type: string includeDocument: type: object insertedAt: type: string format: date-time nullable: true insertedById: type: string nullable: true joinPolicy: type: string nullable: true llmModelName: type: string nullable: true logGroup: type: string nullable: true logStream: type: string nullable: true mappedOutput: type: object maxParallel: type: integer format: int32 nullable: true maxStepsToInsert: type: integer format: int32 nullable: true moduleRef: type: string nullable: true moduleRefs: type: object name: type: string nullable: true options: type: object organization: $ref: '#/components/schemas/Organization' nullable: true organizationId: type: string nullable: true outputMapping: type: object perDocument: type: boolean nullable: true plannerContext: type: object prompt: type: string nullable: true promptActions: type: object promptBody: type: string nullable: true promptRendered: type: string nullable: true promptResult: type: object promptTemplateRef: type: string nullable: true promptVariables: type: object requestBody: type: object requestHeaders: type: object requestPath: type: object requestQuery: type: object requestScript: type: string nullable: true result: type: object scriptActions: type: object scriptBody: type: string nullable: true scriptResult: type: object scriptSidecars: type: object sequence: type: integer format: int32 nullable: true serviceBridgeRef: type: string nullable: true skipReason: type: string nullable: true slug: type: string nullable: true startedOn: type: string format: date-time nullable: true status: type: string taskData: type: object taskStatusSlug: type: string nullable: true taskTemplateRef: type: string nullable: true timeoutSeconds: type: integer format: int32 nullable: true treatAsError: type: string nullable: true type: type: string updatedOn: type: string format: date-time uuid: type: string waitForCompletion: type: boolean nullable: true TaskActivityDetail: type: object properties: interpolatedValues: type: object additionalProperties: {} type: type: string enum: - TASK_CREATED - TITLE_CHANGED - DESCRIPTION_UPDATED - STATUS_CHANGED - ASSIGNEE_CHANGED - DUE_DATE_CHANGED - PROJECT_CHANGED - COMMENT - TASK_LOCKED - TASK_UNLOCKED - TASK_SAVED TaskTemplateMetadata: type: object properties: actions: type: array items: $ref: '#/components/schemas/TaskTemplateAction' aiNaming: $ref: '#/components/schemas/AINamingConfig' nullable: true chatPrompt: $ref: '#/components/schemas/ChatPromptConfig' nullable: true companion: $ref: '#/components/schemas/TaskCompanionConfig' nullable: true documentFamilyGroups: type: array items: $ref: '#/components/schemas/DocumentFamilyGroup' executionPolicy: $ref: '#/components/schemas/ExecutionPolicy' nullable: true forms: type: array items: $ref: '#/components/schemas/TemplateDataForm' options: type: array items: $ref: '#/components/schemas/TaskTemplateOption' priority: type: integer format: int32 nullable: true properties: type: object additionalProperties: {} teamSlug: type: string workspaceId: type: string NodeDimensions: type: object properties: height: type: number format: double width: type: number format: double NodePosition: type: object properties: x: type: number format: double 'y': type: number format: double PossibleValue: type: object properties: description: type: string label: type: string value: {} AINamingConfig: type: object properties: enabled: type: boolean prompt: type: string ChatPromptConfig: type: object properties: enabled: type: boolean prompt: type: string TaskCompanionConfig: type: object properties: agentRuntimeRef: type: string nullable: true moduleRefs: type: array items: type: string prompt: type: string nullable: true DocumentFamilyGroup: type: object properties: automaticallyAdd: type: boolean nullable: true documentFamilyFilter: type: string editable: type: boolean nullable: true hardMaxPages: type: integer format: int32 nullable: true knowledgeFeatures: type: array items: $ref: '#/components/schemas/DocumentFamilyGroupFeature' maxHits: type: integer format: int32 nullable: true maxPages: type: integer format: int32 nullable: true maxSize: type: integer format: int32 nullable: true name: type: string notes: type: string sort: type: string titlePrompt: type: string uniqueFilenames: type: boolean nullable: true uploadOnly: type: boolean nullable: true TemplateDataForm: type: object properties: actions: type: array items: $ref: '#/components/schemas/TaskTemplateAction' availablePanels: type: object additionalProperties: type: boolean dataFormRef: type: string properties: type: object additionalProperties: {} TaskTemplateOption: type: object properties: aliases: type: array items: type: string default: {} description: type: string developerOnly: type: boolean nullable: true displayProperties: type: object additionalProperties: {} falseLabel: type: string featureFlag: type: string groupOptions: type: array items: $ref: '#/components/schemas/TaskTemplateOption' hint: type: string label: type: string listDescription: type: string listLabel: type: string listType: type: string name: type: string overviewMarkdown: type: string possibleValues: type: array items: $ref: '#/components/schemas/TaskPossibleValue' properties: type: object additionalProperties: {} required: type: boolean nullable: true showIf: type: string showOnPopup: type: boolean nullable: true subType: type: string supportArticle: type: string tabName: type: string type: type: string DocumentFamilyGroupFeature: type: object properties: featureTypeRef: type: string required: type: boolean nullable: true TaskPossibleValue: type: object properties: description: type: string label: type: string value: {} securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens. bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT Bearer token obtained from the authentication provider. ````