> ## 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 DataForms

> Creates a new DataForms. Data forms define structured data capture forms for documents.



## OpenAPI

````yaml /api-reference/api-docs.yaml post /api/data-forms
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/data-forms:
    post:
      tags:
        - Data Forms
      summary: Create DataForms
      description: >-
        Creates a new DataForms. Data forms define structured data capture forms
        for documents.
      operationId: createDataForms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFormMetadata'
      responses:
        '201':
          description: Created DataForms
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFormMetadata'
        '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:
    DataFormMetadata:
      type: object
      properties:
        changeSequence:
          type: integer
          format: int32
          description: Optimistic locking version number.
        createdOn:
          type: string
          format: date-time
          description: Timestamp when the data form was created.
        deleteUserEmail:
          type: string
          nullable: true
        deleteUserId:
          type: string
          nullable: true
        deleted:
          type: boolean
        deletedDate:
          type: string
          format: date-time
          nullable: true
        deprecated:
          type: boolean
          description: Whether this data form is deprecated.
        extensionPackRef:
          type: string
        id:
          type: string
          description: Unique identifier (UUID) for the data form.
        metadata:
          $ref: '#/components/schemas/DataForm'
        name:
          type: string
          description: Display name of the data form.
        organizationId:
          type: string
        publicAccess:
          type: boolean
          description: Whether the data form is publicly accessible.
        slug:
          type: string
          description: URL-friendly identifier for the data form.
        template:
          type: boolean
          description: Whether this data form is a template.
        type:
          type: string
        updatedOn:
          type: string
          format: date-time
          description: Timestamp when the data form was last updated.
        uuid:
          type: string
          description: Secondary UUID identifier.
        yamlSource:
          type: string
          nullable: true
      description: Data form metadata defines a structured data capture form for documents.
    DataForm:
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/DataFormAction'
        bridge:
          $ref: '#/components/schemas/BridgeConfig'
          nullable: true
        cards:
          type: array
          items:
            $ref: '#/components/schemas/Card'
        checksum:
          type: string
        deleteProtection:
          type: boolean
          nullable: true
        description:
          type: string
        editable:
          type: boolean
          nullable: true
        entrypoints:
          type: array
          items:
            type: string
        eventTriggers:
          type: array
          items:
            $ref: '#/components/schemas/EventTrigger'
        icon:
          type: string
        imageUrl:
          type: string
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/UINode'
        options:
          type: array
          items:
            $ref: '#/components/schemas/DataFormOption'
        overviewMarkdown:
          type: string
        provider:
          type: string
        providerImageUrl:
          type: string
        providerUrl:
          type: string
        scriptModules:
          type: object
          additionalProperties:
            type: object
        scriptTriggers:
          type: array
          items:
            $ref: '#/components/schemas/ScriptTrigger'
        scripts:
          type: object
          additionalProperties:
            type: string
        version:
          type: string
        views:
          type: array
          items:
            $ref: '#/components/schemas/DataFormView'
    DataFormAction:
      type: object
      properties:
        name:
          type: string
        properties:
          type: object
          additionalProperties: {}
        type:
          type: string
    BridgeConfig:
      type: object
      properties:
        apiBaseUrl:
          type: string
        maxExecutionMs:
          type: integer
          format: int32
          nullable: true
        permissions:
          type: array
          items:
            type: string
    Card:
      type: object
      properties:
        children:
          type: array
          items:
            $ref: '#/components/schemas/Card'
        id:
          type: string
        properties:
          type: object
          additionalProperties: {}
        type:
          type: string
    EventTrigger:
      type: object
      properties:
        debounce:
          type: integer
          format: int32
          nullable: true
        filter:
          $ref: '#/components/schemas/EventTriggerFilter'
          nullable: true
        'on':
          type: string
        script:
          type: string
    UINode:
      type: object
      properties:
        bindings:
          type: object
          additionalProperties:
            type: string
        children:
          type: array
          items:
            $ref: '#/components/schemas/UINode'
        class: {}
        component:
          type: string
        computed:
          type: object
          additionalProperties:
            type: string
        events:
          type: object
          additionalProperties:
            type: object
        for:
          $ref: '#/components/schemas/ForConfig'
          nullable: true
        if:
          type: string
        key:
          type: string
        meta:
          $ref: '#/components/schemas/NodeMeta'
          nullable: true
        props:
          type: object
          additionalProperties: {}
        ref:
          type: string
        show:
          type: string
        slots:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
        style: {}
    DataFormOption:
      type: object
      properties:
        default: {}
        description:
          type: string
        displayProperties:
          type: object
          additionalProperties: {}
        label:
          type: string
        name:
          type: string
        possibleValues:
          type: array
          items: {}
        required:
          type: boolean
          nullable: true
        type:
          type: string
    ScriptTrigger:
      type: object
      properties:
        debounce:
          type: integer
          format: int32
          nullable: true
        script:
          type: string
        triggerOn:
          type: array
          items:
            type: string
    DataFormView:
      type: object
      properties:
        name:
          type: string
        properties:
          type: object
          additionalProperties: {}
    EventTriggerFilter:
      type: object
      properties:
        dataObjectUUID:
          type: string
        path:
          type: string
    ForConfig:
      type: object
      properties:
        indexAs:
          type: string
        itemAs:
          type: string
        key:
          type: string
        source:
          type: string
    NodeMeta:
      type: object
      properties:
        category:
          type: string
        description:
          type: string
        designOnly:
          type: boolean
          nullable: true
        label:
          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.

````