Getting Started With SyncDock
Install SyncDock and turn WordPress into a headless publishing target for AI agents, SaaS apps, and automation pipelines.
On this page
You publish to WordPress programmatically with SyncDock by installing the free plugin, generating an API key scoped to exactly what your client may do, and pointing your agent, app, or pipeline at the /wp-json/syncdock/v1/ namespace with the X-SyncDock-Key header. No cookies, no nonces, no login session — a credential built for software rather than browsers.
Before you begin
- WordPress 6.4 or later with PHP 7.4 or later
- An administrator account to install the plugin and mint keys
- An external client that can send HTTP requests with a custom header
What SyncDock is
SyncDock is a free, GPL-licensed headless WordPress API plugin — an MCP-style gateway that runs beside the native REST API, never over it. It registers its own namespace, so every plugin, theme, and integration already calling /wp/v2/ keeps working untouched; deactivate SyncDock and the extra namespace simply disappears.
The native REST API assumes a logged-in user and a human deciding what to send. SyncDock supplies what autonomous clients need instead: durable hashed credentials, ten granular permission scopes, optional HMAC-SHA256 request signing, Gutenberg-aware writes, and an activity log that answers what actually published that post.
First-time setup
Install SyncDock from the WordPress.org plugin directory and activate it. Then create your first API key in the admin screen: pick its permission scopes, choose whether HMAC signing is disabled, optional, or required, and copy the raw key immediately — it is shown exactly once, then stored only as a SHA-256 hash. Key management, scoping, and signing are covered in depth in the API keys and scopes guide.
Test the connection with a read call:
curl https://example.com/wp-json/syncdock/v1/context/site-info \
-H "X-SyncDock-Key: YOUR_KEY"A JSON response with your site configuration means authentication works end to end.
What the namespace covers
The API surface splits into four areas. Content: full post CRUD, Gutenberg block JSON across 18+ core block types, block-level partial updates, scheduled publishing, and revision restore. Media: multipart or base64 uploads with server-side MIME validation, plus attach and detach. Context: /context/posts (recent, popular, similar content with gap analysis), /context/taxonomies, /context/media, and /context/site-info, so an agent can understand a site before writing into it. Discovery: multi-taxonomy filtering with AND/OR logic, date-range queries, and full-text search with highlighted excerpts.
SEO metadata pushed with a post is written into Yoast SEO, Rank Math, or All in One SEO automatically, falling back to native meta fields when none is installed.
The current release (1.0.1) covers default posts only. Custom post type support is planned for v1.1.0 — if your pipeline depends on CPTs, wait for that release.
Next steps
SyncDock
Headless publishing for WordPress — push posts in from external tools and AI pipelines over a clean, authenticated API.
See also
Related documentation
- SyncDock API Keys, Scopes & HMAC SigningCreate SyncDock API keys, assign least-privilege permission scopes, and decide when to require HMAC-SHA256 request signing.
- Publishing Posts to WordPress With the SyncDock APICreate Gutenberg posts via the SyncDock API, edit single blocks, schedule publication, and attach media from any external client.