> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simplicity.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Form

> Update the details of an existing form. You can update your `form_title`, `form_description`, and especially the `source_document_ids` used to fill your form. 



## OpenAPI

````yaml put /v1/forms/{form_id}
openapi: 3.1.0
info:
  title: AI Form-Filler API
  version: 0.1.0
servers:
  - url: https://api.simplicity.ai
    description: Production
  - url: http://localhost:8000
    description: Local
security: []
paths:
  /v1/forms/{form_id}:
    put:
      tags:
        - forms
      summary: Update Form
      description: >-
        Update the details of an existing form. You can update your
        `form_title`, `form_description`, and especially the
        `source_document_ids` used to fill your form. 
      operationId: update_form_v1_forms__form_id__put
      parameters:
        - name: form_id
          in: path
          required: true
          schema:
            type: string
            title: Form Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormBaseUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormDetailedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    FormBaseUpdate:
      properties:
        form_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Description
        form_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Title
        source_document_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Source Document Ids
      type: object
      title: FormBaseUpdate
    FormDetailedResponse:
      properties:
        form_id:
          type: string
          title: Form Id
        form_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Description
        form_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Title
        form_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Name
        original_form_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Original Form Name
        form_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Form Url
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        last_filled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Filled At
        file_size:
          anyOf:
            - type: number
            - type: 'null'
          title: File Size
        fillable_field_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fillable Field Count
        source_document_details:
          items:
            $ref: '#/components/schemas/SourceDocumentDetail'
          type: array
          title: Source Document Details
      type: object
      required:
        - form_id
        - source_document_details
      title: FormDetailedResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SourceDocumentDetail:
      properties:
        file_key:
          anyOf:
            - type: string
            - type: 'null'
          title: File Key
        external_document_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Document Id
        document_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Document Id
        extension:
          anyOf:
            - type: string
            - type: 'null'
          title: Extension
        original_filename:
          anyOf:
            - type: string
            - type: 'null'
          title: Original Filename
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      title: SourceDocumentDetail
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````