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

# Update Ideation

> Update an ideation. Bumps version when content fields change.



## OpenAPI

````yaml /openapi.json patch /api/v1/ideations/{ideation_id}
openapi: 3.1.0
info:
  description: >-
    Okto Pulse REST API schema generated from okto-pulse-core 0.2.0 source for
    docs.oktolabs.ai.
  title: Okto Pulse
  version: 0.2.0
servers: []
security: []
paths:
  /api/v1/ideations/{ideation_id}:
    patch:
      tags:
        - ideations
      summary: Update Ideation
      description: Update an ideation. Bumps version when content fields change.
      operationId: update_ideation_api_v1_ideations__ideation_id__patch
      parameters:
        - in: path
          name: ideation_id
          required: true
          schema:
            title: Ideation Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdeationUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdeationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    IdeationUpdate:
      description: Schema for updating an ideation.
      properties:
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        complexity:
          anyOf:
            - type: string
            - type: 'null'
          title: Complexity
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        problem_statement:
          anyOf:
            - type: string
            - type: 'null'
          title: Problem Statement
        proposed_approach:
          anyOf:
            - type: string
            - type: 'null'
          title: Proposed Approach
        scope_assessment:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Scope Assessment
        screen_mockups:
          anyOf:
            - items:
                $ref: '#/components/schemas/ScreenMockup'
              type: array
            - type: 'null'
          title: Screen Mockups
        title:
          anyOf:
            - maxLength: 500
              minLength: 1
              type: string
            - type: 'null'
          title: Title
      title: IdeationUpdate
      type: object
    IdeationResponse:
      description: Schema for full ideation response.
      properties:
        architecture_designs:
          default: []
          items:
            $ref: '#/components/schemas/ArchitectureDesignSummary'
          title: Architecture Designs
          type: array
        archived:
          default: false
          title: Archived
          type: boolean
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        board_id:
          title: Board Id
          type: string
        complexity:
          anyOf:
            - $ref: '#/components/schemas/IdeationComplexity'
            - type: 'null'
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        knowledge_bases:
          default: []
          items:
            $ref: '#/components/schemas/IdeationKnowledgeSummary'
          title: Knowledge Bases
          type: array
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        pre_archive_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Pre Archive Status
        problem_statement:
          anyOf:
            - type: string
            - type: 'null'
          title: Problem Statement
        proposed_approach:
          anyOf:
            - type: string
            - type: 'null'
          title: Proposed Approach
        qa_items:
          default: []
          items:
            $ref: '#/components/schemas/IdeationQAResponse'
          title: Qa Items
          type: array
        refinements:
          default: []
          items:
            $ref: '#/components/schemas/RefinementSummary'
          title: Refinements
          type: array
        scope_assessment:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Scope Assessment
        screen_mockups:
          anyOf:
            - items:
                $ref: '#/components/schemas/ScreenMockup'
              type: array
            - type: 'null'
          title: Screen Mockups
        specs:
          default: []
          items:
            $ref: '#/components/schemas/SpecSummary'
          title: Specs
          type: array
        status:
          $ref: '#/components/schemas/IdeationStatus'
        title:
          title: Title
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        version:
          title: Version
          type: integer
      required:
        - id
        - board_id
        - title
        - description
        - problem_statement
        - proposed_approach
        - scope_assessment
        - complexity
        - status
        - version
        - assignee_id
        - created_by
        - created_at
        - updated_at
        - labels
      title: IdeationResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ScreenMockup:
      description: A single screen/view in the mockup set. Contains HTML+Tailwind content.
      properties:
        annotations:
          anyOf:
            - items:
                $ref: '#/components/schemas/MockupAnnotation'
              type: array
            - type: 'null'
          title: Annotations
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        html_content:
          default: ''
          title: Html Content
          type: string
        id:
          title: Id
          type: string
        order:
          default: 0
          title: Order
          type: integer
        screen_type:
          default: page
          title: Screen Type
          type: string
        title:
          title: Title
          type: string
      required:
        - id
        - title
      title: ScreenMockup
      type: object
    ArchitectureDesignSummary:
      description: Lightweight architecture design summary without heavy diagram payloads.
      properties:
        adapter_payload_refs:
          items:
            type: string
          title: Adapter Payload Refs
          type: array
        board_id:
          title: Board Id
          type: string
        breaking_change_flag:
          default: false
          title: Breaking Change Flag
          type: boolean
        created_at:
          format: date-time
          title: Created At
          type: string
        diagrams_count:
          default: 0
          title: Diagrams Count
          type: integer
        id:
          title: Id
          type: string
        parent_id:
          title: Parent Id
          type: string
        parent_type:
          enum:
            - ideation
            - refinement
            - spec
            - card
          title: Parent Type
          type: string
        requires_arch_review:
          default: false
          title: Requires Arch Review
          type: boolean
        source_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Ref
        source_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Version
        stale:
          default: false
          title: Stale
          type: boolean
        title:
          title: Title
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        version:
          title: Version
          type: integer
      required:
        - id
        - board_id
        - parent_type
        - parent_id
        - title
        - version
        - created_at
        - updated_at
      title: ArchitectureDesignSummary
      type: object
    IdeationComplexity:
      description: Ideation complexity level — determines whether refinements are needed.
      enum:
        - small
        - medium
        - large
      title: IdeationComplexity
      type: string
    IdeationKnowledgeSummary:
      description: Lightweight ideation KB summary (without content).
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        ideation_id:
          title: Ideation Id
          type: string
        mime_type:
          title: Mime Type
          type: string
        title:
          title: Title
          type: string
      required:
        - id
        - ideation_id
        - title
        - description
        - mime_type
        - created_at
      title: IdeationKnowledgeSummary
      type: object
    IdeationQAResponse:
      description: Schema for ideation Q&A response.
      properties:
        allow_free_text:
          default: false
          title: Allow Free Text
          type: boolean
        answer:
          anyOf:
            - type: string
            - type: 'null'
          title: Answer
        answered_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Answered At
        answered_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Answered By
        asked_by:
          title: Asked By
          type: string
        choices:
          anyOf:
            - items:
                $ref: '#/components/schemas/IdeationQAChoiceOption'
              type: array
            - type: 'null'
          title: Choices
        created_at:
          format: date-time
          title: Created At
          type: string
        id:
          title: Id
          type: string
        ideation_id:
          title: Ideation Id
          type: string
        question:
          title: Question
          type: string
        question_type:
          default: text
          title: Question Type
          type: string
        selected:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Selected
      required:
        - id
        - ideation_id
        - question
        - answer
        - asked_by
        - answered_by
        - created_at
        - answered_at
      title: IdeationQAResponse
      type: object
    RefinementSummary:
      description: Schema for refinement summary.
      properties:
        archived:
          default: false
          title: Archived
          type: boolean
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        board_id:
          title: Board Id
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        ideation_id:
          title: Ideation Id
          type: string
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        pre_archive_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Pre Archive Status
        status:
          $ref: '#/components/schemas/RefinementStatus'
        title:
          title: Title
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        version:
          title: Version
          type: integer
      required:
        - id
        - ideation_id
        - board_id
        - title
        - description
        - status
        - version
        - assignee_id
        - created_by
        - created_at
        - updated_at
        - labels
      title: RefinementSummary
      type: object
    SpecSummary:
      description: Schema for spec summary (without nested cards).
      properties:
        architecture_designs:
          default: []
          items:
            $ref: '#/components/schemas/ArchitectureDesignSummary'
          title: Architecture Designs
          type: array
        archived:
          default: false
          title: Archived
          type: boolean
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        board_id:
          title: Board Id
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: string
        ideation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Ideation Id
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        pre_archive_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Pre Archive Status
        refinement_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Refinement Id
        status:
          $ref: '#/components/schemas/SpecStatus'
        title:
          title: Title
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        version:
          title: Version
          type: integer
      required:
        - id
        - board_id
        - title
        - description
        - status
        - version
        - assignee_id
        - created_by
        - created_at
        - updated_at
        - labels
      title: SpecSummary
      type: object
    IdeationStatus:
      description: Ideation lifecycle status.
      enum:
        - draft
        - review
        - approved
        - evaluating
        - done
        - cancelled
      title: IdeationStatus
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    MockupAnnotation:
      description: A design note attached to a screen.
      properties:
        author_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Author Id
        id:
          title: Id
          type: string
        text:
          title: Text
          type: string
      required:
        - id
        - text
      title: MockupAnnotation
      type: object
    IdeationQAChoiceOption:
      description: A single option in an ideation Q&A choice question.
      properties:
        id:
          title: Id
          type: string
        label:
          title: Label
          type: string
      required:
        - id
        - label
      title: IdeationQAChoiceOption
      type: object
    RefinementStatus:
      description: Refinement lifecycle status.
      enum:
        - draft
        - review
        - approved
        - done
        - cancelled
      title: RefinementStatus
      type: string
    SpecStatus:
      description: Spec lifecycle status.
      enum:
        - draft
        - review
        - approved
        - validated
        - in_progress
        - done
        - cancelled
      title: SpecStatus
      type: string
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````