> ## 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. # Get a run's resource suggestions > Right-sizing advice for the stages of the pipeline definition a run was planned from: for each stage, the 95th percentile of what its latest successful attempts used, plus 25% headroom, against what it asks for, with how many samples it rests on. Memory is sized from the kernel's memory peak; a stage whose peak reached its limit is at_limit with no suggestion. CPU is sized from mean cores and suggests the request. Only the caller's organisation's runs are counted. Requires pipelines.read. Read-only: nothing is written back to the definition. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs/{run_id}/resource-suggestions openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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: Deploy Targets description: >- Environments, the hosts registered to receive deployments, and the releases deployed to them. - 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: 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: OVH Credentials description: OVH credentials and SSH keys. - 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: 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: /api/v1/org/pipeline-repositories/{repository_id}/pipeline-runs/{run_id}/resource-suggestions: get: tags: - Pipelines summary: Get a run's resource suggestions description: >- Right-sizing advice for the stages of the pipeline definition a run was planned from: for each stage, the 95th percentile of what its latest successful attempts used, plus 25% headroom, against what it asks for, with how many samples it rests on. Memory is sized from the kernel's memory peak; a stage whose peak reached its limit is at_limit with no suggestion. CPU is sized from mean cores and suggests the request. Only the caller's organisation's runs are counted. Requires pipelines.read. Read-only: nothing is written back to the definition. operationId: getPipelineRunResourceSuggestionsToken parameters: - name: repository_id in: path required: true schema: type: string format: uuid - name: run_id in: path required: true schema: type: string format: uuid - name: window in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: How many of each stage's latest successful attempts to size from. responses: '200': description: One suggestion per stage. content: application/json: schema: $ref: '#/components/schemas/PipelineResourceSuggestions' '401': description: Authentication required '403': description: Missing pipelines.read '404': description: No such pipeline repository or run in the organisation '422': description: Malformed id or window '500': description: Internal error security: - BearerAuth: [] components: schemas: PipelineResourceSuggestions: type: object additionalProperties: false required: - run_id - definition_id - window - method - stages properties: run_id: type: string format: uuid definition_id: type: - string - 'null' format: uuid description: >- The pipeline definition the run was planned from, whose attempts the suggestions are sized from. Null for a run that names none, which then carries no stages. window: type: integer minimum: 1 maximum: 100 description: How many of each stage's latest successful attempts were considered. method: $ref: '#/components/schemas/PipelineResourceSuggestionMethod' stages: type: array items: $ref: '#/components/schemas/PipelineStageResourceSuggestion' description: >- One entry per stage with at least one successful attempt that carried a usage report, in name order. A stage absent from the list has no such attempt yet, not zero use. PipelineResourceSuggestionMethod: type: object additionalProperties: false required: - percentile - headroom_percent - minimum_samples - memory_at_limit_percent - cpu_throttled_share_percent - tolerance_percent - cpu_reserve_percent description: The parameters every suggestion in the body is made of. properties: percentile: type: integer description: The percentile of the samples a suggestion is sized from. headroom_percent: type: integer description: Added on top of that percentile. minimum_samples: type: integer description: Samples an axis needs before it is sized at all. memory_at_limit_percent: type: integer description: >- A memory peak this close to its limit is read as the limit (page cache fills spare room), not the need. cpu_throttled_share_percent: type: integer description: >- A stage that spent at least this share of its CPU demand throttled at its limit is at_limit. tolerance_percent: type: integer description: A suggestion this close to the current request is right_sized. cpu_reserve_percent: type: integer description: The share of the declared CPU a step reserves as its request. PipelineStageResourceSuggestion: type: object additionalProperties: false required: - stage - sample_count - memory - cpu properties: stage: type: string sample_count: type: integer description: >- Successful attempts with a usage report in the window; each axis says how many it could use. memory: $ref: '#/components/schemas/PipelineMemoryResourceSuggestion' cpu: $ref: '#/components/schemas/PipelineCPUResourceSuggestion' PipelineMemoryResourceSuggestion: type: object additionalProperties: false required: - status - samples - current_request_bytes - peak_p95_bytes - peak_max_bytes - at_limit_samples - oom_killed_samples - suggested_bytes - suggested properties: status: type: string enum: - oversized - undersized - right_sized - at_limit - insufficient_samples - unknown_request samples: type: integer current_request_bytes: type: - integer - 'null' description: 'The newest sample''s memory request: the stage''s declared memory.' peak_p95_bytes: type: - integer - 'null' description: >- The percentile of the samples' memory peaks (memory.peak, page cache included). peak_max_bytes: type: - integer - 'null' at_limit_samples: type: integer oom_killed_samples: type: integer suggested_bytes: type: - integer - 'null' suggested: type: - string - 'null' description: >- The value for the stage's resources.memory; null when there is no suggestion. PipelineCPUResourceSuggestion: type: object additionalProperties: false required: - status - samples - current_request_millicores - current_limit_millicores - mean_p95_millicores - throttled_share_p95 - suggested_request_millicores - suggested properties: status: type: string enum: - oversized - undersized - right_sized - at_limit - insufficient_samples - unknown_request samples: type: integer description: >- Attempts that carried a CPU total over a known run time of at least a second. current_request_millicores: type: - integer - 'null' current_limit_millicores: type: - integer - 'null' mean_p95_millicores: type: - integer - 'null' description: >- The percentile of each attempt's mean cores over the time its script ran. CPU has no kernel peak; this sizes the request. throttled_share_p95: type: - number - 'null' description: >- The percentile of the share of each attempt's CPU demand spent throttled at its limit, 0 to 1. suggested_request_millicores: type: - integer - 'null' suggested: type: - string - 'null' description: >- The value for the stage's resources.cpu, which reserves the suggested request; null when there is no suggestion. Lowering it lowers the ceiling too. securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.