> ## Documentation Index > Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt > Use this file to discover all available pages before exploring further. # Read summary progress for a stack profile version (browser session) > Requires current profiles.write authority and source ownership. Returns private progress metadata only, with null generation when no job exists. Active jobs take priority, followed by the latest recorded job. Draft reads require the currently loaded source revision and return 409 if it changed; an older draft job is explicitly stale. Version reads never return jobs from a different immutable version. Candidate content requires the separate exact-source generation read. Database failures are not absence. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /org/stack-profiles/{profile_id}/versions/{version}/summary-generation openapi: 3.1.0 info: title: Ankra Platform API version: v1 description: >- The Ankra platform HTTP contract. The /api/v1 surface is the public, bearer-authenticated API used by the Ankra CLI, MCP clients and automation; send a personal or service API token as `Authorization: Bearer `. Browser routes under /org and /chat are served on api.platform.ankra.app (each declares that server); they and /oauth/access authenticate with the ankra_session cookie, and mutations also require the X-Ankra-CSRF header. Every operation declares the credential it accepts, and no operation is served without one. This document is published deliberately: it describes the contract only and carries no organisation data or credentials. Report security issues to security@ankra.ai (see /.well-known/security.txt). servers: - url: https://platform.ankra.app security: - BearerAuth: [] tags: - name: Onboarding description: >- Generate a first website from a prompt and deploy it to a new organisation's cluster. - name: Access Gate description: >- Private service sign-in and membership checks for trusted Ankra proxy relays. - name: Canvas Datasets description: >- Read the fixed, named datasets canvas dashboards bind their charts, tables and stats to. - name: Canvases description: >- Keep dashboards and pages in the organisation's canvas library, with revision history, undo and pins. - name: Canvas Pages description: >- Publish a chat canvas artifact at a public pages address and take it down again. - name: Cloud Delegation description: >- Platform browser consent and organisation-bound connections for Ankra Cloud. - name: Organisation IAM description: >- Custom organisation roles and scoped role assignments for member and service-account identities. - name: Clusters description: Create, inspect and manage clusters, and the stacks deployed on them. - name: Managed Clusters description: Provider-managed control planes, driven through one common surface. - name: Imported Clusters description: Clusters that already existed and were connected to Ankra. - name: Cluster Access description: Kubeconfigs, service-account tokens and per-cluster access grants. - name: Kubernetes description: Read and act on the Kubernetes objects inside a cluster. - name: AWS Clusters description: >- Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in your own VPC. - name: Ankra Cloud Clusters description: >- Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud servers: a private network, a NAT router and a bastion per cluster. - name: DigitalOcean Clusters description: Provision and manage DigitalOcean Kubernetes clusters. - name: Hetzner Clusters description: Provision and manage Hetzner Kubernetes clusters. - name: OVH Clusters description: Provision and manage OVH Kubernetes clusters. - name: Scaleway Clusters description: Provision and manage Scaleway Kapsule clusters. - name: UpCloud Clusters description: Provision and manage UpCloud Kubernetes clusters. - name: Applications description: Deploy, configure and observe applications across the fleet. - name: Pipelines description: >- Pipeline definitions, the approval of the authority they declare, and the caches pipelines keep between runs. - name: Workspaces description: >- Personal workspaces on the organisation's CI pool where a repository's heavy commands run, and the repository profiles they are built from. - name: Deploy Targets description: >- Environments, the hosts registered to receive deployments, and the releases deployed to them. - name: Deploy Provenance description: >- Whether an application's deploys verify signed provenance from the organisation's own pipeline, the keys that provenance is signed with, and a dry-run that verifies images without deploying. - name: Backups description: >- Backup vaults, restore points, protection posture and captures for stacks and application deployments; a completed capture is not a verified restore. - name: Stack Profiles description: Reusable stack definitions, their versions and sharing. - name: Services description: >- Versioned service packages and explicit sharing. Runtime admission is separate from publication. - name: Charts description: Browse the chart catalogue behind stacks and addons. - name: Helm description: Helm registries, credentials and the charts they expose. - name: Executions description: Long-running platform executions and their jobs. - name: Operations description: Cancel in-flight cluster operations and their jobs. - name: Chat description: Conversational sessions, plans and confirmable actions. - name: AI Management description: >- Customer agent lifecycle, authenticated identity and organisation automation controls. - name: AI Agent Runs description: Autonomous agent runs and their outcomes. - name: AI Tickets description: The AI ticket board, its sync connections and settings. - name: AI Playbooks description: Reusable playbooks the AI lanes execute. - name: AI Conditions description: Conditions that gate AI autonomy. - name: AI Remediation description: >- The organisation's auto-remediation policy: what the AI lanes may fix by themselves, and who approves the rest. - name: AI Engineering Handoffs description: Work the AI lanes escalate to a human engineer. - name: AI Environment description: The environment and base stacks AI demos deploy into. - name: AI Memory description: >- What the assistant has learned about you: your cross-session memories and learned profile. - name: MCP Servers description: >- Register the MCP servers the organisation's AI agents can call, choose their tools and grant them to roles. - name: Security description: Findings, advisories, SBOMs, compliance and posture. - name: Cost description: Cluster and fleet cost, rate cards and cost settings. - name: Decisions description: >- The decision ledger behind the Security and Cost queues: proposals a surface computed, the approve and set-aside decisions people took on them, and the receipts of running them. - name: Usage description: >- What your organisation used of Ankra - vCPU-hours, playgrounds, managed services, hosted logs and metrics, and AI - per meter and period, with how completely it was measured and whether a published rate applies. - name: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - name: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address. - name: Account Tokens description: Personal access tokens for the API and CLI. - name: Credentials description: The shared credential store. - name: AWS Credentials description: >- AWS credentials: access keys or CloudFormation-onboarded STS roles for cost, EKS and self-managed provisioning. - name: Ankra Cloud Credentials description: >- Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud lanes. - name: Azure Credentials description: Azure credentials and SSH keys. - name: DigitalOcean Credentials description: DigitalOcean credentials and SSH keys. - name: Hetzner Credentials description: Hetzner credentials and SSH keys. - name: HPE Morpheus Credentials description: HPE Morpheus credentials and the capacity and quotas behind them. - name: OVH Credentials description: OVH credentials and SSH keys. - name: Proxmox Credentials description: Proxmox VE credentials and the capacity and quotas behind them. - name: Scaleway Credentials description: Scaleway credentials. - name: UpCloud Credentials description: UpCloud credentials and SSH keys. - name: Data Source Credentials description: Credentials for metrics and log sources. - name: DNS Credentials description: Credentials for DNS providers. - name: Object Storage Buckets description: >- Buckets Ankra creates and manages on an organisation's own provider credentials. - name: DNS description: DNS zones and records, including custom organisation zones. - name: Cloudflare description: Cloudflare domains and the credentials behind them. - name: Avura description: >- The linked Avura organization, the domains it shares with Ankra Platform, and their DNS records. - name: Variables description: Organisation- and cluster-scoped variables. - name: Secret Slots description: >- Store secrets in Vault and reference them by ${SECRET_SLOT:} sentinel instead of by value. - name: SOPS description: Encrypt and decrypt values with the organisation SOPS config. - name: Alerts description: Alert integrations and ingest credentials. - name: Notifications description: Notification routes and their delivery targets. - name: Support description: Support tickets. - name: AI Settings description: Organisation AI provider, model catalog and per-function model settings paths: /org/stack-profiles/{profile_id}/versions/{version}/summary-generation: get: tags: - Stack Profiles summary: Read summary progress for a stack profile version (browser session) description: >- Requires current profiles.write authority and source ownership. Returns private progress metadata only, with null generation when no job exists. Active jobs take priority, followed by the latest recorded job. Draft reads require the currently loaded source revision and return 409 if it changed; an older draft job is explicitly stale. Version reads never return jobs from a different immutable version. Candidate content requires the separate exact-source generation read. Database failures are not absence. operationId: get_stack_profile_version_summary_status_browser parameters: - in: path name: profile_id required: true schema: type: string format: uuid - in: path name: version required: true schema: type: integer minimum: 1 responses: '200': description: Current authorized summary state headers: Cache-Control: schema: type: string enum: - private, no-store Retry-After: schema: type: string description: Polling delay in seconds while queued or running. content: application/json: schema: $ref: '#/components/schemas/ProfileSummarySourceStatus' '401': description: Authentication required '403': description: >- Requires profiles.write and source ownership; approval requires a person '404': description: Source, generation or selected approved evidence is not visible '409': description: >- Source, candidate or approved-pointer revision changed; reload before deciding '500': description: The summary could not be read or validated; do not treat as absent security: - SessionCookie: [] servers: - url: https://api.platform.ankra.app components: schemas: ProfileSummarySourceStatus: type: object additionalProperties: false required: - source_revision - generation - summary - admission_enabled properties: admission_enabled: type: boolean description: >- Whether the service allows new generation requests. Current permission, consent and capacity are still checked at admission; retained exact-key replay remains available when false. source_revision: type: integer minimum: 1 generation: anyOf: - $ref: '#/components/schemas/ProfileSummaryGenerationStatus' - type: 'null' summary: $ref: '#/components/schemas/StackProfileSummaryView' description: >- Current approval for this exact source revision, independent of retained generation history. A failed approval read is an error, never an absent summary. ProfileSummaryGenerationStatus: type: object additionalProperties: false properties: id: type: string format: uuid state: type: string enum: - queued - running - succeeded - failed - cancelled - expired - superseded review_state: type: string enum: - unreviewed - approved - rejected - stale revision: type: integer minimum: 1 candidate_revision: type: integer minimum: 0 source_revision: type: integer minimum: 1 error_code: type: string enum: - quota_exceeded - provider_unavailable - unsupported_source - stale_source - invalid_output - cancelled - timed_out - permission_denied stale: type: boolean description: >- The job belongs to an older draft revision. It can be cancelled but its candidate must not be used for the current source. content_expired: type: boolean description: >- The private candidate retention deadline has passed. Its content cannot be read, edited or reviewed. Previously approved summaries remain available. required: - id - state - review_state - revision - candidate_revision - source_revision - stale - content_expired StackProfileSummaryView: oneOf: - type: object additionalProperties: false properties: state: type: string enum: - available summary_revision: type: integer minimum: 0 schema_version: type: integer enum: - 1 policy_version: type: string outcomes: type: array items: $ref: '#/components/schemas/ProfileSummaryOutcome' maxItems: 5 coverage: type: array items: $ref: '#/components/schemas/ProfileSummaryCoverage' maxItems: 256 parameters: type: array items: $ref: '#/components/schemas/ProfileSummaryParameter' maxItems: 64 snapshot_fingerprint: description: >- Present only in private author status, never public/shared summary reads. type: string pattern: ^[a-f0-9]{64}$ minLength: 64 maxLength: 64 required: - state - summary_revision - schema_version - policy_version - outcomes - type: object additionalProperties: false properties: state: type: string enum: - absent - unsupported_schema - unsupported_policy summary_revision: type: integer minimum: 0 required: - state - summary_revision - type: object additionalProperties: false properties: state: type: string enum: - withdrawn summary_revision: type: integer minimum: 1 withdrawal_reason: type: string enum: - incorrect_claim - sensitive_content - outdated_policy - author_request required: - state - summary_revision - withdrawal_reason description: >- Exact-version approved projection. Database failures are errors, never absent. With no approved summary, retain the existing profile description and resource inventory. ProfileSummaryOutcome: type: object additionalProperties: false properties: kind: type: string enum: - logging - search - certificates - storage - workloads claims: type: array items: $ref: '#/components/schemas/ProfileSummaryClaim' maxItems: 16 minItems: 1 required: - kind - claims ProfileSummaryCoverage: type: object additionalProperties: false properties: resource_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ reason: type: string enum: - unsupported_format - missing_artifact - unresolved_parameter - redacted - capped - cluster_dependent - invalid_configuration required: - resource_id - reason ProfileSummaryParameter: type: object additionalProperties: false properties: id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ default: type: boolean required: - id ProfileSummaryClaim: type: object additionalProperties: false properties: fact_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ resource_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ subject_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ statement: type: string description: >- Deterministic configuration wording; not a live-state or security certification. applicability: type: string enum: - fixed - default - conditional scope_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ condition: $ref: '#/components/schemas/ProfileSummaryCondition' required: - fact_id - resource_id - subject_id - statement - applicability ProfileSummaryCondition: type: object additionalProperties: false properties: operator: type: string enum: - equals - all - any - not parameter_id: type: string pattern: ^[a-z][a-z0-9_-]{0,63}$ equals: type: boolean children: type: array items: $ref: '#/components/schemas/ProfileSummaryCondition' maxItems: 8 required: - operator description: >- Trusted boolean condition. Maximum depth 4 and 32 nodes; equality names a declared boolean parameter. Conditions are inseparable from their claim. securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http SessionCookie: description: Browser session. Mutations also require X-Ankra-CSRF. in: cookie name: ankra_session type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.