> ## 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. # Upload file to document store > Uploads a file to the document store, creating a new document family and native content object. The file is stored in S3 and a document family record is created with the given path and metadata. ## OpenAPI ````yaml /api-reference/api-docs.yaml post /api/document-stores/{id}/upload 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/document-stores/{id}/upload: post: tags: - Document Stores summary: Upload file to document store description: >- Uploads a file to the document store, creating a new document family and native content object. The file is stored in S3 and a document family record is created with the given path and metadata. operationId: uploadToDocumentStore parameters: - name: id in: path description: Unique identifier (UUID) of the resource. required: true schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 - name: path in: query description: File path within the store. Defaults to the uploaded filename. schema: type: string - name: metadata in: query description: JSON string of key-value metadata to attach to the document family. schema: type: string - name: documentVersion in: query description: Optional document version string. schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: File to upload required: - file responses: '200': description: Created document family content: application/json: schema: $ref: '#/components/schemas/DocumentFamily' '400': description: Bad Request — file missing, duplicate path, or invalid metadata. '401': description: Unauthorized — authentication is required. '403': description: Forbidden — the authenticated user does not have permission. '404': description: Not Found — no document store exists with the given ID. '503': description: Storage not configured — object storage is not available. components: schemas: DocumentFamily: type: object properties: changeSequence: type: integer format: int32 description: Optimistic locking version number. contentObjects: type: array items: $ref: '#/components/schemas/ContentObject' description: Content objects belonging to this document family, ordered by index. created: type: string format: date-time nullable: true description: Original file creation date. createdOn: type: string format: date-time description: Timestamp when the document family was created. deleteUserEmail: type: string nullable: true description: Email of the user who deleted the document family. deleted: type: boolean description: Whether the document family has been soft-deleted. deletedDate: type: string format: date-time nullable: true description: Timestamp when the document family was soft-deleted. documentStatus: type: string nullable: true description: Current processing status of the document. documentTaxonValidations: type: array items: $ref: '#/components/schemas/DocumentTaxonValidation' description: Validation results against the document taxonomy. executionTargets: $ref: '#/components/schemas/ExecutionTargets' description: Processing execution targets for this document. id: type: string description: Unique identifier (UUID) for the document family. example: b1234567-89ab-cdef-0123-456789abcdef locked: type: boolean description: Whether the document family is locked for processing. metadata: type: object additionalProperties: type: object description: Document metadata extracted during processing. metadataSource: type: object additionalProperties: type: object description: Maps metadata keys to their source content object IDs. modified: type: string format: date-time nullable: true description: Original file modification date. originalPath: type: string nullable: true description: Original path before soft-deletion or rename. path: type: string description: File path or name of the document. example: invoices/2025/q4/invoice-001.pdf pendingProcessing: type: boolean description: Whether the document family is queued for processing. size: type: integer format: int64 description: File size in bytes. example: 245760 statistics: $ref: '#/components/schemas/DocumentFamilyStatistics' nullable: true storeRef: type: string description: Reference to the document store containing this document family. summary: type: string description: AI-generated summary of the document content. updatedOn: type: string format: date-time description: Timestamp when the document family was last updated. uuid: type: string description: Secondary UUID identifier. description: >- A document family groups related content objects representing a single logical document, tracking its processing lifecycle. ContentObject: type: object properties: changeSequence: type: integer format: int32 description: Optimistic locking version number. contentMetadata: type: object additionalProperties: type: object description: Content-level metadata extracted during processing. contentType: type: integer format: int32 description: 'Type of content: DOCUMENT or NATIVE.' created: type: string format: date-time nullable: true createdOn: type: string format: date-time description: Timestamp when the content object was created. docTransitionType: type: string documentFamilyId: type: string nullable: true description: ID of the parent document family. documentTaxonValidations: type: array items: $ref: '#/components/schemas/DocumentTaxonValidation' documentVersion: type: string description: Document version identifier. id: type: string description: Unique identifier (UUID) for the content object. index: type: integer format: int32 description: Ordering index within the document family. metadata: type: object additionalProperties: type: object description: Metadata extracted from the content. mixins: type: array items: type: string description: >- List of mixin names applied to this content object (e.g., spatial, workbook, text). modified: type: string format: date-time nullable: true name: type: string size: type: integer format: int64 description: File size in bytes. source: $ref: '#/components/schemas/SourceMetadata' description: Source/origin metadata for the content object. sourceContentObjectId: type: string nullable: true storeRef: type: string description: Reference to the storage location. summary: type: string description: AI-generated summary of the content. updatedOn: type: string format: date-time description: Timestamp when the content object was last updated. uuid: type: string description: Secondary UUID identifier. description: >- A content object represents an individual file or processing result within a document family. DocumentTaxonValidation: type: object properties: taxonPath: type: string taxonomyRef: type: string validation: $ref: '#/components/schemas/TaxonValidation' nullable: true ExecutionTargets: type: object properties: instances: type: array items: $ref: '#/components/schemas/ExecutionTarget' DocumentFamilyStatistics: type: object properties: changeSequence: type: integer format: int32 createdOn: type: string format: date-time id: type: string recentExecutions: type: array items: $ref: '#/components/schemas/RecentExecution' updatedOn: type: string format: date-time uuid: type: string description: >- Document family statistics contain processing metrics for a document family. SourceMetadata: type: object properties: checksum: type: string cid: type: string connector: type: string created: type: string document_family_id: type: string headers: type: object additionalProperties: {} last_modified: type: string lineage_document_uuid: type: string mime_type: type: string original_filename: type: string original_path: type: string source_document_uuid: type: string TaxonValidation: type: object properties: conditional: type: boolean nullable: true conditionalFormula: type: string description: type: string detailFormula: type: string disabled: type: boolean nullable: true exceptionId: type: string messageFormula: type: string name: type: string overridable: type: boolean nullable: true ruleFormula: type: string supportArticleId: type: string ExecutionTarget: type: object properties: actor: $ref: '#/components/schemas/DocumentActor' nullable: true contentObjectId: type: string documentFamilyId: type: string labelsToApply: type: array items: type: string ref: type: string taxonomyRefs: type: array items: type: string type: type: string enum: - DOCUMENT_STORE - TAXONOMY_STORE - DATA_STORE RecentExecution: type: object properties: assistant: $ref: '#/components/schemas/Assistant' nullable: true changeSequence: type: integer format: int32 createdOn: type: string format: date-time execution: $ref: '#/components/schemas/Execution' nullable: true id: type: string updatedOn: type: string format: date-time uuid: type: string description: >- A recent execution records a document processing execution for quick access. DocumentActor: type: object properties: actorId: type: string actorType: type: string enum: - USER - ASSISTANT - ACCESS_TOKEN - API 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. Execution: type: object properties: assistantId: type: string nullable: true changeSequence: type: integer format: int32 description: Optimistic locking version number. context: type: object additionalProperties: type: object createdOn: type: string format: date-time description: Timestamp when the execution was created. description: type: string documentFamilyId: type: string nullable: true endDate: type: string format: date-time nullable: true exceptionDetails: $ref: '#/components/schemas/ExceptionDetails' nullable: true id: type: string description: Unique identifier (UUID) for the execution. idempotencyKey: type: string nullable: true organizationId: type: string parentExecutionId: type: string nullable: true pipeline: $ref: '#/components/schemas/ExecutionPipeline' nullable: true priority: type: integer format: int32 processingTime: type: integer format: int64 sessionId: type: string nullable: true startDate: type: string format: date-time nullable: true status: type: string enum: - PENDING - RUNNING - SUCCEEDED - FAILED - REQUESTED - SKIPPED - CANCELLING - CANCELLED - PENDING_REPROCESSING - REPROCESSED statusDetails: $ref: '#/components/schemas/StatusDetails' nullable: true targets: $ref: '#/components/schemas/SessionExecutionTargets' nullable: true updatedOn: type: string format: date-time description: Timestamp when the execution was last updated. uuid: type: string description: Secondary UUID identifier. description: An execution records the details and results of a processing session. 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' ExceptionDetails: type: object properties: advice: type: string cause: {} description: type: string documentationUrl: type: string errorMessage: type: string errorType: type: string executedVersion: type: string help: type: string message: type: string optionErrors: type: object additionalProperties: {} stackTrace: type: array items: {} statusCode: type: integer format: int32 validationErrors: type: array items: $ref: '#/components/schemas/ValidationError' ExecutionPipeline: type: object properties: exceptions: type: array items: $ref: '#/components/schemas/ExceptionDetails' id: type: string ref: type: string steps: type: array items: $ref: '#/components/schemas/ExecutionStep' valid: type: boolean StatusDetails: type: object properties: detail: type: string message: type: string progress: type: integer format: int32 progressMax: type: integer format: int32 stepStatus: type: string SessionExecutionTargets: type: object properties: instances: type: array items: $ref: '#/components/schemas/SessionExecutionTarget' 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. 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. 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 ValidationError: type: object properties: description: type: string message: type: string option: type: string ExecutionStep: type: object properties: conditional: type: string context: type: object additionalProperties: {} end: type: string nullable: true exceptionDetails: $ref: '#/components/schemas/ExceptionDetails' nullable: true executionPolicy: $ref: '#/components/schemas/ExecutionPolicy' nullable: true extensionPackRef: type: string id: type: string inputId: type: string name: type: string optionTypes: type: object additionalProperties: type: string options: type: object additionalProperties: {} outputId: type: string outputIds: type: string processingTime: type: integer format: int64 nullable: true progress: type: integer format: int32 nullable: true progressMax: type: integer format: int32 nullable: true ref: type: string start: type: string nullable: true status: type: string enum: - PENDING - RUNNING - SUCCEEDED - FAILED - REQUESTED - SKIPPED - CANCELLING - CANCELLED - PENDING_REPROCESSING - REPROCESSED statusMessage: type: string stepType: type: string enum: - MODULE SessionExecutionTarget: type: object properties: contentObjectId: type: string documentFamilyId: type: string labelsToApply: type: array items: type: string ref: type: string taxonomyRefs: type: array items: type: string type: 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 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' 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: {} FavoriteLink: type: object properties: link: type: string 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. ````