Manage your PHP site through the Agent API.
Connect scripts and coding agents to a VoxelSite installation. The beta REST API provides authenticated access to pages, assets, publishing and AI requests on your server.
GET /_studio/api/agent/v1/pages
Host: example.com
Authorization: Bearer YOUR_API_KEY
Accept: application/jsonEnable API access and create a key in Studio. Replace the example host and key before making a request.
Enable access for a specific job.
The API is off by default. Enable it in Settings → API Access, create a key, and grant the permissions your integration needs. Keep the key in your server or automation tool.
Bearer authentication
Send the key in the Authorization header. VoxelSite checks its permissions and request limit before running the operation. You can label and revoke keys in the Studio.
Example: read the page list after enabling the API. Replace the example host and key with your installation details.
GET /_studio/api/agent/v1/pages
Host: example.com
Authorization: Bearer YOUR_API_KEY
Accept: application/jsonUse GET /_studio/api/agent/v1/schema for the OpenAPI contract and response definitions.
Choose the operations you need.
| Resource | What your integration can do |
|---|---|
/pages | Read, create, update, and delete site pages. |
/assets | List assets and upload files. |
/compile, /publish | Compile Tailwind CSS or publish the working site. |
/settings | Read supported settings. Writing settings requires an Owner key and follows the allowed setting list. |
/submissions | Read form and action submissions. |
/tools | List tools and invoke them through the tools endpoint. |
| AI prompts | Run generation with an explicit prompt:execute permission. Requests use the installation's AI provider and API balance. |
/schema | Read the public OpenAPI schema without a key. |
Scope each API key.
API-key roles have their own permission limits. They differ from a person's Studio access: an Editor can publish in the Studio, but an Editor API key has no publish permission.
Viewer and Editor keys
Viewer keys read pages, settings, submissions, and assets. Editor keys read and write pages and assets, read submissions, compile CSS, and invoke tools. Neither role can publish through the API.
Agent and Owner keys
Agent keys support editing and publishing but cannot write settings. Owner keys can write allowed settings too. Grant only the scopes your integration needs.
AI execution is opt-in
The Owner must grant prompt:execute to an eligible Owner, Editor, or Agent key. A prompt can change site files and incur API costs. Inspect its result before publishing.
Choose the interface for the job.
Studio MCP
Authenticated website management from a coding agent. Create and edit a private draft, review changes, publish and restore within the connection’s permissions. See Studio MCP
Agent API
Your authenticated tools can edit and publish the site within their granted permissions. You build the integration with your HTTP client; naming a tool here does not imply a prebuilt connector.
Public MCP endpoint
Compatible AI clients can query public site information and submit enabled Actions. Public read-only MCP tools work in a PHP ZIP export. Public action tools, Studio MCP and the Agent API need the Studio backend. The public endpoint does not grant site-management access.
Test against your installation.
The Agent API is in beta. Use the schema and guide for exact methods, payloads, permissions, and errors. On Nginx, confirm that PHP receives the Authorization header before testing a key.