> ## Documentation Index > Fetch the complete documentation index at: https://docs.sandywp.com/llms.txt > Use this file to discover all available pages before exploring further. # Validate or adapt a Blueprint > Validation without `blueprintId` is public, including requests with `adapt: true`; it returns findings and, when adapting, an adapted source. Supplying `blueprintId` always requires a bearer token so the server can inspect a saved bundle. This conditional authentication cannot be expressed per request shape, so this operation declares no OpenAPI security requirement. ## OpenAPI ````yaml /openapi.yaml post /api/app/blueprints/validate openapi: 3.1.0 info: title: SandyWP API version: 0.1.0 summary: Complete supported customer API for SandyWP automation. description: > This is the complete supported customer API for automating SandyWP sandboxes, reusable Templates and Blueprints, Imports, Workspaces, account credentials, and OAuth connection setup. It is the stable HTTP contract for developer integrations; browser, provider, and operations routes on the same host are deliberately not part of this document. **Exclusions ledger.** The specification excludes guest/launcher creation (`POST /api/sites`), account profile/avatar/password/support and GitHub UI handlers, billing checkout/portal/sync, public launch routes, plugin/theme search proxies, storage, activity telemetry, newsletter, health, metrics, impersonation, Slack/GitHub callbacks, Git/Polar webhooks, all `/api/admin/**`, and all `/api/internal/**` worker or SSH-control routes. Those endpoints are browser backends, provider callbacks, or operational control-plane interfaces rather than supported developer APIs. ## Conventions - Requests and responses are JSON. Send `Content-Type: application/json` on writes (the file upload and plugin-ZIP-upload endpoints instead use `multipart/form-data`, as noted on those operations). - Sandboxes and Templates are addressed by their opaque `id` in the API (for example `site_abc123`, `tpl_xyz789`). - Errors use a consistent envelope — see the `Error` schema. Some actions require a paid plan and fail with HTTP `402` and a specific error code (for example `template_sharing_requires_paid_plan`); each is called out on the operation that returns it. - **Async by default.** Provisioning and other slow sandbox mutations happen on a worker, not inline in the HTTP request. An endpoint that starts one either returns a `jobId` to poll (see the `Job` / `JobSummary` schemas and each operation's description), returns the resource in a non-terminal state (a site `"creating"`, a Template `"building"`) to re-fetch until it settles, or both. - A personal bearer token can call the authenticated operations below. A scoped OAuth token is accepted only by `GET /api/account/me` and the Imports family; it needs `import:read` or `import:write` for the matching import operation. Other REST operations treat scoped tokens as unauthenticated. contact: name: SandyWP url: https://app.sandywp.com/docs/api servers: - url: https://app.sandywp.com security: - bearerAuth: [] tags: - name: Templates description: >- A Template is a snapshot of a finished sandbox — WordPress/PHP versions, plugins, themes, content, and database — ready to restore in seconds. Templates come from saving a ready sandbox, and can optionally be published as a public "launch this demo" link. - name: Sites description: >- A Site is a disposable WordPress sandbox: its lifecycle (create/restore/reset/delete) and the per-sandbox tools built on top of it (PHP runtime & ini config, WordPress debug settings, database access, outgoing-email capture, plugin deploys, the file manager, Git deployment, and SSH access). - name: Blueprints description: >- Reviewable WordPress build recipes that can be validated, saved, run on a sandbox, or baked into a Template. - name: Imports description: >- Archive-upload workflows for cloning a live WordPress site or pushing a local installation. Scoped OAuth tokens may use only this family, with `import:read` for reads and `import:write` for mutations. - name: Workspaces description: Workspace selection plus member and custom-role administration. - name: Account description: Identity, usage, personal API tokens, and account SSH public keys. - name: OAuth description: >- Public-client registration and PKCE authorization-code token exchange for supported connectors. paths: /api/app/blueprints/validate: post: tags: - Blueprints summary: Validate or adapt a Blueprint description: >- Validation without `blueprintId` is public, including requests with `adapt: true`; it returns findings and, when adapting, an adapted source. Supplying `blueprintId` always requires a bearer token so the server can inspect a saved bundle. This conditional authentication cannot be expressed per request shape, so this operation declares no OpenAPI security requirement. operationId: validateBlueprint requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateBlueprintRequest' responses: '200': description: Compatibility findings and optional adapted source. content: application/json: schema: $ref: '#/components/schemas/BlueprintValidationResult' '400': $ref: '#/components/responses/BadRequest' '401': description: '`auth_required` — required only when `blueprintId` is supplied.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- `blueprint_not_found` — the saved Blueprint is not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/Error' security: [] components: schemas: ValidateBlueprintRequest: type: object description: Supply `source` or its legacy `sourceJson` alias. anyOf: - required: - source - required: - sourceJson properties: source: oneOf: - type: string - $ref: '#/components/schemas/BlueprintDocument' sourceJson: deprecated: true oneOf: - type: string - $ref: '#/components/schemas/BlueprintDocument' sourceUrl: type: string format: uri description: Optional base URL used while adapting external Blueprint resources. adapt: type: boolean default: false description: Return a SandyWP-adapted source and adaptation changes. blueprintId: type: string description: Saved Blueprint id. Its presence requires bearer authentication. BlueprintValidationResult: type: object description: >- Validation output. `source` and `changes` are present only for adaptation responses or bundle previews. required: - valid - schemaVersion - stepCount - hoisted - findings properties: valid: type: boolean description: >- False when one or more compatibility findings have `severity: error`. schemaVersion: type: integer enum: - 1 - 2 stepCount: type: integer minimum: 0 hoisted: $ref: '#/components/schemas/BlueprintHoistedEnvironment' findings: type: array items: $ref: '#/components/schemas/BlueprintCompatibilityFinding' source: $ref: '#/components/schemas/BlueprintDocument' changes: type: array items: $ref: '#/components/schemas/BlueprintAdaptationChange' manifestDirectory: type: string description: Present for a ZIP bundle preview. Error: type: object description: >- The standard error envelope returned by every endpoint on a non-2xx response. required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- A stable, machine-readable error code (e.g. `invalid_request`, `site_not_found`, `plan_limit_reached`). See each operation for the codes it can return. example: invalid_request message: type: string description: A human-readable message. Safe to display to an end user. details: type: object description: >- Optional structured context (e.g. `{"plan": "free", "limit": 2}` for a plan-limit error). Omitted entirely on the generic internal-error fallback; `{}` when an error has no extra context. additionalProperties: true BlueprintDocument: type: object description: >- A WordPress Playground Blueprint document. SandyWP accepts schema version 1 or 2 and validates its supported steps and resources before saving or running it. additionalProperties: true example: preferredVersions: php: '8.3' wp: latest steps: - step: setSiteOptions options: blogname: My Sandbox BlueprintHoistedEnvironment: type: object required: - phpVersion - requestedPhpVersion - wordpressVersion - requestedWordpressVersion - multisite properties: phpVersion: type: - string - 'null' description: Supported PHP version inferred from the source, if any. requestedPhpVersion: type: - string - 'null' wordpressVersion: type: - string - 'null' description: Supported WordPress version inferred from the source, if any. requestedWordpressVersion: type: - string - 'null' multisite: type: boolean BlueprintCompatibilityFinding: type: object required: - severity - path - code - message properties: severity: type: string enum: - error - warning - info path: type: string description: JSON-path-like location in the source document. code: type: string message: type: string BlueprintAdaptationChange: type: object required: - path - code - message properties: path: type: string code: type: string enum: - field_removed - step_removed - step_transformed - resource_transformed message: type: string subject: type: string description: Optional affected step name. responses: BadRequest: description: >- The request body, parameters, or resource state is invalid for this operation. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Personal API token, sent as `Authorization: Bearer `. Obtain one from the dashboard account menu (API keys), `sandywp auth login`, or `POST /api/account/tokens`. A missing or invalid token returns `401 auth_required`. Scoped OAuth tokens are limited to the Imports family and `GET /api/account/me`; see the top-level conventions. ````