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

# Plan an AutomationGraph apply

> Dry-runs one exact active semantic revision against authenticated live Workspace state with the same server compiler apply uses. It returns resource dispositions, exact managed-field changes, blockers, version pins, required human inputs, and a deterministic fingerprint; it mutates nothing.

Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json post /v1/automation-graphs/{id}/plan
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-27); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: sessionHandoffs
  - name: sessionCapsules
  - name: sessionTrajectories
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/automation-graphs/{id}/plan:
    post:
      tags:
        - automationGraphs
      summary: Plan an AutomationGraph apply
      description: >-
        Dry-runs one exact active semantic revision against authenticated live
        Workspace state with the same server compiler apply uses. It returns
        resource dispositions, exact managed-field changes, blockers, version
        pins, required human inputs, and a deterministic fingerprint; it mutates
        nothing.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        automation-firing. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: automationGraphs.planAutomationGraph
      parameters:
        - name: id
          in: path
          schema:
            $ref: '#/components/schemas/AutomationGraphId'
          required: true
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                revision:
                  type: integer
                  allOf:
                    - exclusiveMinimum: 0
              required:
                - revision
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      graph_id:
                        $ref: '#/components/schemas/AutomationGraphId'
                      revision:
                        type: integer
                        allOf:
                          - exclusiveMinimum: 0
                      plan_fingerprint:
                        type: string
                        allOf:
                          - pattern: ^sha256:[0-9a-f]{64}$
                      kind:
                        type: string
                        enum:
                          - planned
                      entries:
                        type: array
                        items:
                          type: object
                          properties:
                            resource:
                              type: string
                              enum:
                                - automation
                                - delivery_screen
                                - use_agent_permission_assignment
                            disposition:
                              type: string
                              enum:
                                - create
                                - reuse
                                - update
                                - pause
                                - revoke
                                - blocked
                            subject:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                            reason:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                            changes:
                              type: array
                              items:
                                $ref: '#/components/schemas/Objects_121'
                          required:
                            - resource
                            - disposition
                            - subject
                            - changes
                          additionalProperties: false
                      counts:
                        type: object
                        properties:
                          automations_created:
                            type: integer
                            allOf:
                              - minimum: 0
                          automations_updated:
                            type: integer
                            allOf:
                              - minimum: 0
                          automations_paused:
                            type: integer
                            allOf:
                              - minimum: 0
                          screens_required:
                            type: integer
                            allOf:
                              - minimum: 0
                          permission_assignments_created:
                            type: integer
                            allOf:
                              - minimum: 0
                          permission_assignments_reused:
                            type: integer
                            allOf:
                              - minimum: 0
                          permission_assignments_revoked:
                            type: integer
                            allOf:
                              - minimum: 0
                          blocked:
                            type: integer
                            allOf:
                              - minimum: 0
                        required:
                          - automations_created
                          - automations_updated
                          - automations_paused
                          - screens_required
                          - permission_assignments_created
                          - permission_assignments_reused
                          - permission_assignments_revoked
                          - blocked
                        additionalProperties: false
                      agent_versions_pinned:
                        type: array
                        items:
                          type: object
                          properties:
                            agent:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                            version:
                              type: integer
                              allOf:
                                - exclusiveMinimum: 0
                          required:
                            - agent
                            - version
                          additionalProperties: false
                      required_human_inputs:
                        type: array
                        items:
                          type: string
                          enum:
                            - webhook_ingest_secret
                    required:
                      - graph_id
                      - revision
                      - plan_fingerprint
                      - kind
                      - entries
                      - counts
                      - agent_versions_pinned
                      - required_human_inputs
                    additionalProperties: false
                  - type: object
                    properties:
                      graph_id:
                        $ref: '#/components/schemas/AutomationGraphId'
                      revision:
                        type: integer
                        allOf:
                          - exclusiveMinimum: 0
                      plan_fingerprint:
                        type: string
                        allOf:
                          - pattern: ^sha256:[0-9a-f]{64}$
                      kind:
                        type: string
                        enum:
                          - rejected
                      errors:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                            detail:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                            edge:
                              type: string
                              allOf:
                                - maxLength: 16384
                                - minLength: 1
                          required:
                            - code
                            - detail
                          additionalProperties: false
                    required:
                      - graph_id
                      - revision
                      - plan_fingerprint
                      - kind
                      - errors
                    additionalProperties: false
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationMalformedError'
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '409':
          description: The request conflicts with the resource's current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationConflictError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    AutomationGraphId:
      type: string
      allOf:
        - pattern: ^agph_[0-9a-f]{32}$
    Objects_121:
      type: object
      properties:
        path:
          type: string
          allOf:
            - maxLength: 16384
            - minLength: 1
        before:
          anyOf:
            - {}
            - type: 'null'
        after:
          anyOf:
            - {}
            - type: 'null'
      required:
        - path
        - before
        - after
      additionalProperties: false
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    ValidationMalformedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.malformed
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-malformed
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The request could not be decoded or violated a declared input
        constraint.
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    ValidationConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.conflict
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The request conflicts with the resource's current state.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````