Skip to content
General Augment Docs

Plan Desired State

POST
/api/v3/projects/{project_id}/desired-state/plan
curl --request POST \
  --url https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/desired-state/plan \
  --header 'Content-Type: application/json' \
  --data '{ "base_revision_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bundle": { "assets": [ { "content": "example", "content_type": "text/plain; charset=utf-8", "kind": "soul", "path": "example", "sha256": "example" } ], "manifest": "example" }, "mutation": { "identity": { "audience": "example", "issuer_url": "example", "jwks_url": "example", "mode": "app_backend", "tenant_id_claim": "example", "user_id_claim": "sub" }, "type": "project.identity.set" } }'

Validate and diff proposed source without creating any durable object.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
DesiredStatePlanRequestV3

Exactly one complete source or typed mutation for a write-free plan.

object
base_revision_id
Any of:
string format: uuid
bundle
Any of:
ProjectSourceBundleV3

Transport-independent full source bundle used for plan and commit.

object
assets
Assets
Array<object>
<= 500 items
ProjectSourceAssetV3

One source asset supplied with a v3 desired-state bundle.

object
content
required
Content
string
<= 2000000 characters
content_type
Content Type
string
default: text/plain; charset=utf-8 >= 1 characters <= 120 characters
kind
required
Kind
string
Allowed values: soul skill openapi mcp schema
path
required
Path
string
>= 1 characters <= 240 characters
sha256
Any of:
string
/^[0-9a-f]{64}$/
manifest
required
Manifest
string
>= 1 characters <= 1000000 characters
mutation
Any of:
One of: discriminator: type
ProjectIdentitySetV3
object
identity
required
ProjectIdentityV3

Secret-free contract for resolving a stable signed-in application user.

object
audience
Any of:
string
>= 1 characters <= 300 characters
issuer_url
Any of:
string
>= 1 characters <= 2000 characters
jwks_url
Any of:
string
>= 1 characters <= 2000 characters
mode
Mode
string
default: app_backend
Allowed values: app_backend oidc
tenant_id_claim
Any of:
string
>= 1 characters <= 120 characters
user_id_claim
User Id Claim
string
default: sub >= 1 characters <= 120 characters
type
required
Type
string
Allowed value: project.identity.set

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DesiredStatePlanResponseV3

Write-free semantic plan returned to CLI and dashboard.

object
api_version
Api Version
string
default: genaug.desired-state-plan/v3
Allowed value: genaug.desired-state-plan/v3
base_revision
Any of:
ProjectRevisionReferenceV3

Exact server-versioned desired-state head identity.

object
generation
required
Generation
integer
>= 1
revision_id
required
Revision Id
string format: uuid
source_fingerprint
required
Source Fingerprint
string
/^[0-9a-f]{64}$/
blockers
Blockers
Array<string>
changes
Changes
Array<object>
ProjectV3SemanticChange

One stable Project-level semantic change shared by CLI and dashboard.

object
action
required
Action
string
Allowed values: created modified removed
authority_effect
required
Authority Effect
string
Allowed values: none reduced expanded changed
category
required
Category
string
Allowed values: project agent capability connection credential_requirement memory_namespace skill soul delegation identity policy
changed_fields
Changed Fields
Array<string>
display_name
required
Display Name
string
>= 1 characters <= 200 characters
reason_code
required
Reason Code
string
>= 1 characters <= 100 characters
subject_id
required
Subject Id
string
>= 1 characters <= 200 characters
project_id
required
Project Id
string format: uuid
release_fingerprint
required
Release Fingerprint
string
/^[0-9a-f]{64}$/
semantic_diff_fingerprint
required
Semantic Diff Fingerprint
string
/^[0-9a-f]{64}$/
source_fingerprint
required
Source Fingerprint
string
/^[0-9a-f]{64}$/
workspace_id
required
Workspace Id
string format: uuid
Example
{
  "api_version": "genaug.desired-state-plan/v3",
  "changes": [
    {
      "action": "created",
      "authority_effect": "none",
      "category": "project"
    }
  ]
}

401

Section titled “401”

Authentication failed with a resumable next action.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

403

Section titled “403”

The authenticated actor lacks the required Project authority.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

404

Section titled “404”

The scoped management resource was not found.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

409

Section titled “409”

A stable management invariant prevented progress.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}