Skip to content
General Augment Docs

Get Release

GET
/api/v3/projects/{project_id}/releases/{release_id}
curl --request GET \
  --url https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/releases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Return one exact v3 release and its resolved per-Agent execution plans.

Parameters

Section titled “Parameters”

Path Parameters

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

Header Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProjectReleaseResponseV3

One immutable v3 release with optional expanded execution document.

object
binding_set_fingerprint
required
Binding Set Fingerprint
string
/^[0-9a-f]{64}$/
compiler_version
required
Compiler Version
string
created_at
required
Created At
string format: date-time
created_by
Any of:
string
document
Any of:
CanonicalProjectReleaseDocumentV3

Immutable deployment unit compiled from one desired-state revision.

object
binding_set_fingerprint
required
Binding Set Fingerprint
string
/^[0-9a-f]{64}$/
compiler_version
Compiler Version
string
default: 3.0.0
Allowed value: 3.0.0
delegations
Delegations
Array<object>
CanonicalDelegationV3

One immutable delegation edge.

object
destination_agent_id
required
Destination Agent Id
string format: uuid
id
required
Id
string format: uuid
mode
required
Mode
string
Allowed values: as_tool handoff
source_agent_id
required
Source Agent Id
string format: uuid
entry_agent_id
Any of:
string format: uuid
execution_plans
Execution Plans
Array<object>
ProjectExecutionPlanV3

Fully resolved least-privilege execution plan for one Agent.

object
agent_id
required
Agent Id
string format: uuid
capability_ids
Capability Ids
Array<string>
connection_ids
Connection Ids
Array<string>
delegation_ids
Delegation Ids
Array<string>
display_name
Any of:
string
<= 200 characters
effective_guardrails
required
Effective Guardrails
object
key
additional properties
any
effective_limits
required
Effective Limits
object
key
additional properties
integer
instructions
required
Instructions
string
>= 1 characters
is_entry
required
Is Entry
boolean
memory_grants
Memory Grants
Array<object>
CanonicalMemoryGrantV3

One exact namespace grant in an Agent execution plan.

object
access
required
Access
string
Allowed values: read read_write
resource_id
required
Resource Id
string format: uuid
model_preferences
required
Model Preferences
object
key
additional properties
string
name
required
Name
string
>= 1 characters <= 200 characters
purpose
required
Purpose
string
>= 1 characters <= 1000 characters
skill_ids
Skill Ids
Array<string>
slug
required
Slug
string
>= 1 characters <= 80 characters
soul_resource_id
required
Soul Resource Id
string format: uuid
identity
required
Identity
object
key
additional properties
any
model_catalog_version
Any of:
string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}\.[1-9][0-9]*$/
policy
required
Policy
object
key
additional properties
any
project_id
required
Project Id
string format: uuid
project_name
required
Project Name
string
>= 1 characters <= 200 characters
project_slug
required
Project Slug
string
>= 1 characters <= 80 characters
resources
Resources
Array<object>
CanonicalProjectResourceV3

One immutable Project catalog resource.

object
fingerprint
required
Fingerprint
string
/^[0-9a-f]{64}$/
id
required
Id
string format: uuid
kind
required
ProjectResourceKindV3

Complete Project-owned resource categories in a v3 release.

string
Allowed values: capability connection credential_requirement memory_namespace skill soul
name
required
Name
string
>= 1 characters <= 200 characters
spec
Spec
object
key
additional properties
any
schema_version
Schema Version
string
default: genaug.project-release/v3
Allowed value: genaug.project-release/v3
workspace_id
required
Workspace Id
string format: uuid
id
required
Id
string format: uuid
project_id
required
Project Id
string format: uuid
release_fingerprint
required
Release Fingerprint
string
/^[0-9a-f]{64}$/
release_generation
required
Release Generation
integer
>= 1
schema_version
required
Schema Version
string
source_revision
required
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}$/
workspace_id
required
Workspace Id
string format: uuid
Example
{
  "document": {
    "compiler_version": "3.0.0",
    "delegations": [
      {
        "mode": "as_tool"
      }
    ],
    "execution_plans": [
      {
        "memory_grants": [
          {
            "access": "read"
          }
        ]
      }
    ],
    "resources": [
      {
        "kind": "capability"
      }
    ],
    "schema_version": "genaug.project-release/v3"
  }
}

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"
    }
  ]
}