> ## Documentation Index > Fetch the complete documentation index at: https://docs.voyager.so/llms.txt > Use this file to discover all available pages before exploring further. # Delete Snapshot > Delete a snapshot: it is never listed or restored again, and its stored files are deleted. Free. Refused (`409 snapshot_in_use`) while a paused machine resumes from it: resume or release that machine first. Deleting a deleted snapshot answers the same. ## OpenAPI ````yaml /openapi/voyager-api.yaml delete /machines/snapshots/{snapshot} openapi: 3.1.0 info: title: Voyager API description: >- Generate images, video, speech, music, sound effects and 3D with your Voyager workspace's credits. Authenticate with `Authorization: Bearer vy_live_…`. Every response carries `X-Request-ID` and the `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset` (seconds until the window resets) headers; a 429 adds `Retry-After`. Errors share one envelope (`ErrorResponse`); a method a path does not take is 405 `method_not_allowed`. Some catalog operations run only through the Voyager MCP today (voice-change, text-to-motion, retexture, convert-3d, uv-unwrap; `x-voyager-mcp-only-operations`): this API's model listings leave them out. version: 1.0.0 x-voyager-agent-prompt: > Set up the Voyager API in this project. Voyager generates images, video, speech, music, sound effects, 3D, object masks, upscaled media, separated audio, background cut-outs and SVG vectors with the same models and credits as the Voyager app. Docs: https://docs.voyager.so/api (agent-readable: https://docs.voyager.so/llms.txt, OpenAPI: https://api.voyager.so/v1/openapi.json) 1. Key: read it from the env var VOYAGER_API_KEY. Never hard-code it or commit it; add VOYAGER_API_KEY= to .env.example and make sure .env is git-ignored. If it's missing, ask me to create one at https://voyager.so/dashboard/api (paid plans). 2. Base URL https://api.voyager.so/v1, header: Authorization: Bearer $VOYAGER_API_KEY 3. Pick a model: GET /models?type=image|video|speech|music|sound_effect|3d|segment|upscale|audio_separation|remove_background|vectorize. Read GET /models/{id} for its input_schema before building a request. 4. Optional cost check: POST /estimate with the same body as step 5; it returns estimated_charge (credits) and can_run. 5. Create: POST /jobs {"model": "", "operation": "", "input": {...}} with an Idempotency-Key header (a new UUID per logical request; reuse it when retrying the same request). 6. Wait: GET /jobs/{id}?wait=25 until status is succeeded, failed or canceled (honor Retry-After / poll_after_ms). Or pass "webhook_url" and verify the Standard Webhooks signature with the secret from the dashboard. 7. Results: job.outputs[].url is a signed link valid for 1 hour; download it right away, or GET /jobs/{id} again for a fresh link. Files are kept 30 days. 8. Errors are {"error": {"code","message","retryable",...}}. 402 = out of credits or not on a paid plan (show error.details.upgrade_url to me). 429 = slow down: wait Retry-After seconds. Retry only when retryable is true, with the same Idempotency-Key. Minimal example (curl): curl -s https://api.voyager.so/v1/jobs \ -H "Authorization: Bearer $VOYAGER_API_KEY" -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{"model":"nano-banana-2.1","operation":"text-to-image","input":{"prompt":"a red fox in snow","aspect_ratio":"16:9"}}' curl -s "https://api.voyager.so/v1/jobs/?wait=25" -H "Authorization: Bearer $VOYAGER_API_KEY" Write a small typed client (create → wait → download) with retries as above, then generate one test image to prove it works and tell me what it cost (job.credits.charged; if credits.state is still "pending", report job.credits.estimated and say it's an estimate). servers: - url: https://api.voyager.so/v1 description: Production security: [] paths: /machines/snapshots/{snapshot}: delete: tags: - machines summary: Delete Snapshot description: >- Delete a snapshot: it is never listed or restored again, and its stored files are deleted. Free. Refused (`409 snapshot_in_use`) while a paused machine resumes from it: resume or release that machine first. Deleting a deleted snapshot answers the same. operationId: deleteCloudMachineSnapshot parameters: - name: snapshot in: path required: true schema: type: string title: Snapshot responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MachineSnapshotDeleted' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '400': description: The request is invalid (`invalid_request`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '401': description: Missing or invalid credential. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '402': description: >- Not enough credits (`insufficient_credits`); `details.upgrade_url` links to billing. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '403': description: >- This workspace needs a paid Voyager plan (`paid_plan_required`, `verification_required`; `details.upgrade_url`), or the key lacks a scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '404': description: No such machine, job or path. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '409': description: >- The machine is in the wrong state for this (e.g. `machine_paused`: resume it first, `machine_not_ready`, `machine_released`, `conflict`), or the Idempotency-Key was used for a different request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '429': description: Rate limited; retry after `Retry-After` seconds. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' '500': description: >- Something went wrong on our side. Retry, or quote request_id to support. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '503': description: >- No capacity (`capacity_unavailable`) or a temporary outage (`upstream_unavailable`); retry after `Retry-After` seconds. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' security: - API Key: [] components: schemas: MachineSnapshotDeleted: properties: id: type: string title: Id description: The deleted snapshot's id (`snp_…`). deleted: type: boolean const: true title: Deleted description: Always true. deleted_at: anyOf: - type: string - type: 'null' title: Deleted At description: When it was deleted (ISO 8601, UTC). type: object required: - id - deleted - deleted_at title: MachineSnapshotDeleted ErrorResponse: properties: error: $ref: '#/components/schemas/ErrorBody' description: What went wrong. type: object required: - error title: ErrorResponse description: Every non-2xx answer. ErrorBody: properties: type: $ref: '#/components/schemas/ErrorType' description: Stable category to branch on. code: type: string title: Code description: >- Stable machine code; never renamed once published. An open set: x-voyager-errors lists the API's codes, and a refusal passed through from a model or /v1/machines may carry another; branch on type for a code you don't know. x-extensible-enum: - invalid_request - invalid_input - content_policy - upstream_unavailable - input_too_large - rate_limited - queue_full - model_unavailable - model_not_found - insufficient_credits - paid_plan_required - model_not_in_plan - model_access_required - outcome_unknown - expired - not_found - conflict - forbidden - internal_error - catalog_unavailable - catalog_invalid - billing_unavailable - no_voyager_seat - credits_reloading - cast_not_supported - voice_cloning_unavailable - too_many_references - input_too_long - payload_too_large - upload_too_large - intake_full - invalid_url - fetch_failed - unsupported_file - invalid_api_key - idempotency_conflict - idempotency_in_flight - invalid_idempotency_key - invalid_cursor - invalid_webhook_url - method_not_allowed - no_eligible_model - cap_unverifiable - decision_expired - decision_mismatch - decision_price_changed - account_unavailable - plan_required_for_faces - version_conflict - slug_taken - already_referenced - asset_in_use - upload_incomplete - cancel_unsupported - unsupported_cast_version - cast_version_required - cast_empty_package - cast_selection_invalid - cast_not_found - cast_version_mismatch - cast_capacity_exceeded - cast_images_required - cast_prompt_too_long - cast_plan_changed - unsupported_model - invalid_job_id - voice_required - observation_timeout - reference_unavailable - queue_timeout - reference_missing message: type: string title: Message description: For developers. Not localized. doc_url: type: string title: Doc Url description: https://docs.voyager.so/api/errors# request_id: anyOf: - type: string - type: 'null' title: Request Id description: Also in the X-Request-ID header; quote it to support. retryable: anyOf: - type: boolean - type: 'null' title: Retryable description: Whether the same request can succeed later. retry_after_ms: anyOf: - type: integer - type: 'null' title: Retry After Ms description: How long to wait before retrying. param: anyOf: - type: string - type: 'null' title: Param description: >- The request field at fault, as a path (e.g. input.resolution); set whenever the error is about one field. loc: anyOf: - items: type: string type: array - type: 'null' title: Loc description: >- param as a path of parts (e.g. ["input", "resolution"]); set whenever param is. details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: Code-specific detail, e.g. upgrade_url on a billing wall. type: object required: - type - code - message - doc_url title: ErrorBody ErrorType: type: string enum: - invalid_request - authentication - permission - not_found - conflict - rate_limited - idempotency_conflict - unprocessable - upstream_error - internal_error title: ErrorType description: Closed set of high-level categories SDKs branch on. headers: X-Request-ID: description: This request's id (also error.request_id). schema: type: string X-RateLimit-Limit: description: >- Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key). schema: type: integer X-RateLimit-Remaining: description: Requests left in this window. schema: type: integer X-RateLimit-Reset: description: Seconds until the window resets. schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer securitySchemes: API Key: type: http description: API key from Settings > Developer > REST API scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.