Setting up an agent rather than being one? Start with Build with AI Agents:
installing the SaladCloud skills, the documentation MCP server, and API key guidance.
When to use this runbook
Use this page before any autonomous Container Engine, AI Gateway, or Transcription task and whenever sources disagree, identifiers are missing, or an action could stop/cancel work, reduce capacity, replace an instance, or repeat potentially billable or non-idempotent work.When not to use it
Do not use these runbooks for Gateway Service, S4, general account administration, or as a substitute for live account data. AI Gateway account, organization, credit, and key creation remain user-facing Portal tasks.Required inputs
SALAD_API_KEYfor the public SaladCloud API, supplied through a secret environment variable and sent only in theSalad-Api-Keyheader.SALAD_AI_GATEWAY_API_KEYfor AI Gateway, supplied through a secret environment variable and sent only as a Bearer token. This key belongs to one user and organization; never substitute the regular SaladCloud API key.SALAD_ORGANIZATIONfor organization-scoped public API operations, obtained from the user, trusted configuration, or the Portal. An AI Gateway key already carries its organization scope; confirm the intended organization from trusted context when it affects billing.- For Container Engine only,
SALAD_PROJECT. Transcription endpoints and AI Gateway do not use a project. - The intended outcome, target resource or model, authorized request content, and authorization boundary.
- Explicit user intent before stopping or deleting a workload, scaling down, replacing or reallocating an instance, or cancelling/resubmitting a transcription job or repeating an uncertain AI Gateway completion.
Authoritative sources
Use this precedence order:- A live API response for current account, availability, quota, or resource state.
- The current
salad-cloud.yaml,salad-cloud-imds.yaml,transcribe.json, ortranscription-lite.jsonfor API paths, operation IDs, schemas, required fields, and enums. - The applicable agent runbook for procedure, safety boundaries, and decision rules.
- Canonical explanatory documentation, such as the Container Engine overview, for product behavior and context.
- Examples only as illustrations. Never treat example identifiers, prices, counts, or states as current facts.
/v1/models results. Do not transfer undocumented fields, idempotency guarantees, or retry behavior from another
provider.
Dynamic values to retrieve
Retrieve immediately before a decision:- The current Container Group, queue, inference endpoint, or transcription job representation.
- Current instances and their
state,ready,started, and version values. - Current quotas, GPU classes, CPU/GPU availability, country constraints, and priority-specific capacity estimates.
- Current queue length, job status, system events, and application logs for the relevant UTC window.
- Current transcription job status, events, timestamps, and output for the exact selected product path and returned ID.
- Current AI Gateway model IDs, documented rates, response and rate-limit metadata, and usage fields returned for the exact request.
Preflight checks
- Confirm no credential value will be printed, logged, committed, or included in returned evidence.
- Confirm the user supplied or approved the organization and any project name required by the selected API.
- Validate the supplied scope with the applicable product read: Container Engine quota/project reads, the exact
Transcription endpoint read, or AI Gateway
GET /v1/models. - For a resource mutation, read the target and compare its current state with the requested outcome.
- Run Container Engine preflight, AI Gateway request preflight, or Transcription preflight.
- Establish a polling or attempt limit and a stop condition before sending a write or billable request.
Procedure
- Select the narrowest task-specific runbook and its corresponding skill.
- Resolve names from trusted input; resolve generated IDs only from live responses or trusted application records.
- Retrieve all dynamic values required for the decision.
- Present or record the planned mutation or billable request and any interruption, capacity, privacy, or cost impact.
- Obtain explicit intent when the action is destructive, capacity-reducing, instance-replacing, or repeats uncertain billable work.
- Perform one mutation or completion, then verify it with the method defined by the selected runbook.
- Return the requested outcome, verification evidence, and any unresolved state without secrets.
Decision rules
Expected states and responses
Successful create operations return a resource or job, while start, stop, delete/cancel, and instance lifecycle operations may return202 Accepted and continue asynchronously. A 2xx response confirms acceptance or immediate
response handling; it is not proof that a runtime state or transcription terminal state has been reached.
AI Gateway returns an immediate completion response or stream. It does not provide a documented reconciliation read for
a completion whose outcome is uncertain, so do not infer that an interrupted request failed or was not billed.
Retry behavior
Follow Safety, Retries, and Freshness. Retry reads and other safe or idempotent requests only within a caller-defined attempt and elapsed-time budget. HonorRetry-After when present. Do
not blindly retry authentication, authorization, validation, conflict, or invalid-configuration failures. Do not
automatically retry an AI Gateway completion after a timeout, 5xx, interrupted response, or partial stream.
Verification
Every mutation requires a verification read from the same trusted organization and, when applicable, project. Success means the live resource reflects the requested configuration/terminal state, or the exact transcription job reaches the expected terminal state and output. Report partial or pending results rather than inferring completion. For AI Gateway, verify the model against a fresh/v1/models response before the request, then verify the exact response or stream
received; there is no documented completion-status read.
Rollback or recovery
Capture a redacted pre-change representation before updating. Prefer a corrective merge patch that restores only the changed fields. Never delete, cancel, replace, or resubmit as an implicit rollback. Transcription jobs cannot be updated; a replacement is a new submission requiring intent. If a prior value is unavailable or redacted, stop. AI Gateway generations and consumed tokens cannot be rolled back; a corrective prompt is a new billable request.Stop and escalation conditions
Stop when credentials, scope, required fields, destructive authorization, current state, or a reliable prior value are missing. Stop after the polling budget expires, on repeated non-transient errors, or when the evidence indicates a product-side issue. Use the troubleshooting runbook to build a support package. For AI Gateway, use Troubleshoot an AI Gateway Request before contacting SaladCloud support.Evidence to return to the user
Return:- Organization and relevant project/resource names; instance or job IDs only when retrieved from trusted evidence.
- Operation IDs or exact endpoint methods/paths and HTTP response classes used, with no credential-bearing headers.
- A concise pre-change summary, the intended change, and the verification read result.
- Current resource/job status, relevant instance counts or job events/output fields, version, and UTC timestamps.
- For AI Gateway, the selected model, streaming mode, response class, safe usage metadata, and UTC timestamp without prompt or generated content unless the user explicitly requests it.
- Partial, pending, failed, or skipped checks and the exact stop reason.
- Recovery performed or the next safe action requiring user approval.