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

# Get Canvas State At Commit

> Get canvas state for a node at a specific historical commit with flat structure.

Returns a flat dictionary where keys are node IDs and values are complete
state objects. The parent node's child_nodes field contains only child node
IDs (not nested objects). Each child node gets its own entry in the dictionary.

This endpoint is used for viewing historical canvas states - the canvas as it
existed at a specific point in time.

Query params:
    resolve_children: "latest" (default) shows children at their current main HEAD.
                      "snapshot" shows children as they were when this commit was pushed.
    include_related: "slim" (default) leaves parents/ingress/egress as stubs.
                     "full" also adds each related node as its own top-level entry
                     (parents from main; ingress/egress are typically empty for
                     non-main commit-history reads) and rewrites the root's
                     parent_nodes to a list of UUIDs.



## OpenAPI

````yaml get /orgs/{org_id}/nodes/{node_id}/tree/{branch}/commits/{commit_id}/canvas
openapi: 3.1.0
info:
  title: Flow API
  description: Content-addressing backend with Git-like versioning
  version: 1.0.0
servers:
  - url: https://api.yertle.com
    description: Production
security: []
paths:
  /orgs/{org_id}/nodes/{node_id}/tree/{branch}/commits/{commit_id}/canvas:
    get:
      tags:
        - node-history
      summary: Get Canvas State At Commit
      description: >-
        Get canvas state for a node at a specific historical commit with flat
        structure.


        Returns a flat dictionary where keys are node IDs and values are
        complete

        state objects. The parent node's child_nodes field contains only child
        node

        IDs (not nested objects). Each child node gets its own entry in the
        dictionary.


        This endpoint is used for viewing historical canvas states - the canvas
        as it

        existed at a specific point in time.


        Query params:
            resolve_children: "latest" (default) shows children at their current main HEAD.
                              "snapshot" shows children as they were when this commit was pushed.
            include_related: "slim" (default) leaves parents/ingress/egress as stubs.
                             "full" also adds each related node as its own top-level entry
                             (parents from main; ingress/egress are typically empty for
                             non-main commit-history reads) and rewrites the root's
                             parent_nodes to a list of UUIDs.
      operationId: >-
        get_canvas_state_at_commit_orgs__org_id__nodes__node_id__tree__branch__commits__commit_id__canvas_get
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Org Id
        - name: node_id
          in: path
          required: true
          schema:
            type: string
            title: Node Id
        - name: branch
          in: path
          required: true
          schema:
            type: string
            title: Branch
        - name: commit_id
          in: path
          required: true
          schema:
            type: string
            title: Commit Id
        - name: resolve_children
          in: query
          required: false
          schema:
            type: string
            pattern: ^(latest|snapshot)$
            default: latest
            title: Resolve Children
        - name: include_related
          in: query
          required: false
          schema:
            type: string
            pattern: ^(slim|full)$
            default: slim
            title: Include Related
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeCanvasStateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    NodeCanvasStateResponse:
      properties: {}
      additionalProperties: true
      type: object
      title: NodeCanvasStateResponse
      description: >-
        Flat canvas state — dictionary keyed by node ID.


        Each value is a push-compatible state object for that node. The schema
        is

        inherently dynamic because keys are UUIDs, so this response type is a

        passthrough JSON object.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````