PageWeave Releases API
Immutable release snapshots of website content.
Immutable release snapshots of website content.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pageweave-dev:pageweave-dev-releases-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: PageWeave Releases API
version: 1.0.0
summary: Programmatic control plane for PageWeave websites.
description: 'Version 1 of the PageWeave HTTP API. Every endpoint under `/api/v1`
authenticates with a bearer API key unless its operation declares an
anonymous alternative — `security: []` or an optional requirement such as
`[{bearerAuth: []}, {}]` for upload sessions.
Errors use RFC 9457 Problem Details (`application/problem+json`). Rate
limits follow draft-ietf-httpapi-ratelimit-headers-11 and are reported on
every authenticated response through the `RateLimit-Policy` and
`RateLimit` headers.
The contract is additive within v1: operations and response fields may be
added, never removed or changed incompatibly.'
contact:
name: PageWeave
url: https://pageweave.dev/docs/api
externalDocs:
description: Guide, authentication, pagination, errors, and worked examples.
url: https://pageweave.dev/docs/api/guide
servers:
- url: https://pageweave.dev
description: Production
tags:
- name: Releases
description: Immutable release snapshots of website content.
paths:
/api/v1/websites/{website_id}/releases:
parameters:
- name: website_id
in: path
required: true
description: Website UUID or subdomain.
schema:
type: string
get:
operationId: listReleases
summary: List releases
tags:
- Releases
security:
- bearerAuth: []
x-required-permission: release.read
x-required-scope: website
x-required-credential: read
parameters:
- $ref: '#/components/parameters/Cursor'
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: A page of results
content:
application/json:
schema:
$ref: '#/components/schemas/ReleasesCollection'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
post:
operationId: createRelease
summary: Create a release
description: 'Creates an immutable snapshot. Creating never publishes: attach it to an environment with PUT /environments/{environment_id}/release.'
tags:
- Releases
security:
- bearerAuth: []
x-required-permission: release.create
x-required-scope: website
x-required-credential: write
parameters:
- $ref: '#/components/parameters/IdempotencyKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseCreateRequest'
example:
scope: all
note: Copy refresh before launch
responses:
'201':
description: The created resource
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseDetail'
example:
id: 019fc8d4-7e5f-8a6b-9c74-3e5f6a7b8c9d
number: 12
host: studio-north.pageweave.site
url: https://studio-north.pageweave.site
scope: all
based_on: 11
note: Copy refresh before launch
created_at: '2026-11-02T10:50:18Z'
attached_environments: []
items:
pages:
- id: 019fb7fa-3d30-7f4a-b844-47efeb446a39
path: /
version: 4
snippets: []
components: []
theme: null
removed:
pages: []
snippets: []
components: []
headers:
Location:
$ref: '#/components/headers/Location'
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/TooManyRequests'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
$ref: '#/components/responses/Unprocessable'
/api/v1/websites/{website_id}/releases/{id}:
parameters:
- name: website_id
in: path
required: true
description: Website UUID or subdomain.
schema:
type: string
- name: id
in: path
required: true
description: Release UUID or number.
schema:
type: string
get:
operationId: getRelease
summary: Get a release
tags:
- Releases
security:
- bearerAuth: []
x-required-permission: release.read
x-required-scope: website
x-required-credential: read
parameters:
- $ref: '#/components/parameters/IfNoneMatch'
responses:
'200':
description: The resource
content:
application/json:
schema:
$ref: '#/components/schemas/ReleaseDetail'
headers:
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
'304':
$ref: '#/components/responses/NotModified'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
headers:
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
ETag:
description: Strong validator for the current representation.
schema:
type: string
Location:
description: Canonical URL of the created or affected resource.
schema:
type: string
format: uri
LastModified:
description: Last modification time (HTTP-date).
schema:
type: string
WWWAuthenticate:
description: 'Bearer challenge (RFC 9110 §11.6.1, RFC 6750 §3).
Carries `error="invalid_token"` when a credential was presented but
could not be resolved. `/api/v1` uses the `api` realm; OAuth
protected-resource metadata (RFC 9728) is advertised by MCP only.
'
schema:
type: string
example: Bearer realm="api", error="invalid_token"
RateLimitPolicy:
description: 'The applicable quota policy (draft-ietf-httpapi-ratelimit-headers-11).
'
schema:
type: string
example: '"write";q=120;w=60'
RateLimit:
description: 'The remaining quota and seconds until the window resets
(draft-ietf-httpapi-ratelimit-headers-11).
'
schema:
type: string
example: '"write";r=119;t=42'
schemas:
ReleaseSummary:
type: object
additionalProperties: false
required:
- id
- number
- host
- url
- scope
- based_on
- note
- created_at
- attached_environments
properties:
id:
type: string
format: uuid
number:
type: integer
host:
type: string
url:
type:
- string
- 'null'
scope:
type: string
enum:
- all
- mine
- selection
based_on:
type:
- integer
- 'null'
note:
type:
- string
- 'null'
created_at:
type: string
format: date-time
attached_environments:
type: array
items:
$ref: '#/components/schemas/ReleaseEnvironment'
ReleaseComponentSelection:
oneOf:
- type: string
- type: object
additionalProperties: false
required:
- type
properties:
type:
type: string
instance_id:
type: string
version:
type: integer
ReleaseEnvironment:
type: object
additionalProperties: false
required:
- id
- name
properties:
id:
type: string
format: uuid
name:
type: string
ReleaseComponentItem:
type: object
additionalProperties: false
required:
- id
- kind
- version
properties:
id:
type: string
format: uuid
kind:
type: string
version:
type:
- integer
- 'null'
ReleasePageItem:
type: object
additionalProperties: false
required:
- id
- path
- version
properties:
id:
type: string
format: uuid
path:
type: string
version:
type:
- integer
- 'null'
ReleaseItems:
type: object
additionalProperties: false
required:
- pages
- snippets
- components
- theme
properties:
pages:
type: array
items:
$ref: '#/components/schemas/ReleasePageItem'
snippets:
type: array
items:
$ref: '#/components/schemas/ReleasePageItem'
components:
type: array
items:
$ref: '#/components/schemas/ReleaseComponentItem'
theme:
oneOf:
- $ref: '#/components/schemas/ReleaseThemeItem'
- type: 'null'
Problem:
type: object
example:
type: https://pageweave.dev/errors/forbidden
title: Forbidden
status: 403
detail: The API key lacks the page.create permission for this website.
instance: /api/v1/websites/019f9c2a-6a1b-7a3d-8f2e-4b6c8d0e1f23/pages
request_id: 019fc8e5-8f6a-9b7c-8d85-4f6a7b8c9d0e
required_permission: page.create
required_permission_scope: website
required_credential_scope: write
required:
- type
- title
- status
- instance
properties:
type:
type: string
format: uri
title:
type: string
status:
type: integer
detail:
type: string
instance:
type: string
request_id:
type:
- string
- 'null'
errors:
type: array
items:
type: object
additionalProperties: false
required:
- field
- detail
properties:
field:
type: string
detail:
type: string
code:
type: string
upgrade_url:
type: string
required_permission:
type:
- string
- 'null'
description: Declared endpoint permission; null for account-level endpoints with no resource permission.
required_permission_scope:
type:
- string
- 'null'
description: Scope the permission resolves in (workspace, website, environment); null when there is no resource permission.
required_credential_scope:
type:
- string
- 'null'
description: The read/write scope the presented bearer credential lacks; present on credential-ceiling 403s.
retry_after_seconds:
type: integer
minimum: 1
description: Seconds until the quota resets (RFC 9457 extension member, on too-many-requests only). Authoritative over retry_at when clocks differ.
retry_at:
type: string
format: date-time
description: UTC "not before" timestamp — when the quota window ends (RFC 9457 extension member, on too-many-requests only).
suggested_path:
type: string
description: First free path for a restore whose original path is taken, when one can be suggested (RFC 9457 extension member; nothing is renamed automatically).
template_pages:
type: array
description: Live template pages that reference a table whose deletion was refused (RFC 9457 extension member).
items:
type: object
additionalProperties: false
required:
- id
- path
properties:
id:
type: string
format: uuid
path:
type: string
conflicts:
type: array
description: Release items edited by someone else after the caller's last edit (RFC 9457 extension member).
items:
type: object
additionalProperties: false
required:
- type
- identifier
- mine_version
- latest_version
- latest_author
properties:
type:
type: string
identifier:
type: string
mine_version:
type: integer
latest_version:
type: integer
latest_author:
type:
- string
- 'null'
matches:
type: array
description: Candidate short ids for an ambiguous feedback reference (RFC 9457 extension member).
items:
type: string
items:
type: array
description: Identifiers that made a release selection invalid (RFC 9457 extension member).
items:
type: string
nameservers:
type: array
description: Live parent NS answer that still delegates a zone to PageWeave, sent with a refused zone deletion (RFC 9457 extension member).
items:
type: string
existing_id:
type: string
format: uuid
description: Identifier of the existing resource that caused a conflict, such as a pending invitation (RFC 9457 extension member).
ReleaseRemove:
type: object
additionalProperties: false
required: []
properties:
pages:
type: array
maxItems: 1000
items:
type: string
snippets:
type: array
maxItems: 1000
items:
type: string
components:
type: array
maxItems: 1000
items:
type: string
ReleasePathSelection:
oneOf:
- type: string
- type: object
additionalProperties: false
required:
- path
properties:
path:
type: string
version:
type: integer
ReleaseDetail:
type: object
additionalProperties: false
required:
- id
- number
- host
- url
- scope
- based_on
- note
- created_at
- attached_environments
- items
- removed
properties:
id:
type: string
format: uuid
number:
type: integer
host:
type: string
url:
type:
- string
- 'null'
scope:
type: string
enum:
- all
- mine
- selection
based_on:
type:
- integer
- 'null'
note:
type:
- string
- 'null'
created_at:
type: string
format: date-time
attached_environments:
type: array
items:
$ref: '#/components/schemas/ReleaseEnvironment'
items:
$ref: '#/components/schemas/ReleaseItems'
removed:
$ref: '#/components/schemas/ReleaseRemoved'
ReleaseRemovedPage:
type: object
additionalProperties: false
required:
- id
- path
properties:
id:
type: string
format: uuid
path:
type:
- string
- 'null'
ReleasesCollection:
type: object
additionalProperties: false
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/ReleaseSummary'
pagination:
$ref: '#/components/schemas/Pagination'
Pagination:
type: object
additionalProperties: false
required:
- limit
- has_more
- next_cursor
properties:
limit:
type: integer
minimum: 0
has_more:
type: boolean
next_cursor:
type:
- string
- 'null'
ReleaseCreateRequest:
type: object
additionalProperties: false
required: []
properties:
scope:
type: string
enum:
- all
- mine
- selection
note:
type:
- string
- 'null'
maxLength: 2000
pages:
type: array
maxItems: 1000
items:
$ref: '#/components/schemas/ReleasePathSelection'
snippets:
type: array
maxItems: 1000
items:
$ref: '#/components/schemas/ReleasePathSelection'
components:
type: array
maxItems: 1000
items:
$ref: '#/components/schemas/ReleaseComponentSelection'
theme:
$ref: '#/components/schemas/ReleaseThemeSelection'
remove:
$ref: '#/components/schemas/ReleaseRemove'
force:
type: boolean
ReleaseThemeSelection:
oneOf:
- type: boolean
- type: object
additionalProperties: false
required:
- version
properties:
version:
type: integer
ReleaseThemeItem:
type: object
additionalProperties: false
required:
- version
properties:
version:
type:
- integer
- 'null'
ReleaseRemoved:
type: object
additionalProperties: false
required:
- pages
- snippets
- components
properties:
pages:
type: array
items:
$ref: '#/components/schemas/ReleaseRemovedPage'
snippets:
type: array
items:
$ref: '#/components/schemas/ReleaseRemovedPage'
components:
type: array
items:
$ref: '#/components/schemas/ReleaseRemovedComponent'
ReleaseRemovedComponent:
type: object
additionalProperties: false
required:
- id
- kind
properties:
id:
type: string
format: uuid
kind:
type:
- string
- 'null'
responses:
Conflict:
description: The request conflicts with the current state (replayed key, in-progress operation)
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
UnsupportedMediaType:
description: Request bodies must use application/json
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
TooManyRequests:
description: A rate limit was exceeded
headers:
Retry-After:
$ref: '#/components/headers/RetryAfter'
RateLimit-Policy:
$ref: '#/components/headers/RateLimitPolicy'
RateLimit:
$ref: '#/components/headers/RateLimit'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Unauthorized:
description: Missing, invalid, expired, or revoked credential
headers:
WWW-Authenticate:
$ref: '#/components/headers/WWWAuthenticate'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Unprocessable:
description: The payload could not be processed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
BadRequest:
description: The request is malformed or carries unknown query parameters
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Forbidden:
description: The session, credential, or role does not permit the action
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
NotFound:
description: The resource does not exist or is not visible to this caller
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
NotModified:
description: The representation has not changed
headers:
ETag:
$ref: '#/components/headers/ETag'
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: false
description: 'Replay-safe key for POST, including bodyless action POSTs such as
revert (1-255 printable ASCII characters,
draft-ietf-httpapi-idempotency-key-header-08). A replay returns the
stored response with `Idempotent-Replayed: true`.
Responses up to 64 KB are stored and replayed in full. Larger responses
keep only status and headers; their replay is bodyless and carries
`Idempotent-Replay-Body-Omitted: true` (follow `Location`). Each user
may hold 10,000 unexpired records across credentials; a new key past
the cap returns 429 with `Retry-After`, while an existing key still
replays.
'
schema:
type: string
minLength: 1
maxLength: 255
Limit:
name: limit
in: query
required: false
description: Page size (1-100, default 25).
schema:
type: integer
minimum: 1
maximum: 100
default: 25
Cursor:
name: cursor
in: query
required: false
description: Opaque keyset cursor from the previous page's `pagination.next_cursor`.
schema:
type: string
IfNoneMatch:
name: If-None-Match
in: header
required: false
description: 'Revalidate a cached representation; a matching value answers 304
without a body (RFC 9110 §13.1.2).
'
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'API key created in Settings → API keys. Send
`Authorization: Bearer pagew_...`. A key''s scopes (`read`, `write`) are
a ceiling: a read-only key cannot write even when its owner''s role
allows it.
'