Skip to content

Quick start

Two short paths, depending on how you’ll use Octa Editor.

  1. Log in and visit any post, page or term archive on the front-end.
  2. Open the Octa Editor panel (the floating button).
  3. Change a field and click Save. Before saving you’ll see a dry-run preview of exactly what will change.
  4. Confirm. The page reloads with your change applied.

See Editor panel → Overview for details.

First create an Application Password. Then:

Read a post as the canonical document:

Terminal window
curl https://example.com/wp-json/octa-editor-api/v1/post/123 \
--user "editor:APPLICATION_PASSWORD"

Preview a change without writing anything (_dry_run):

Terminal window
curl -X POST https://example.com/wp-json/octa-editor-api/v1/post/publish \
--user "editor:APPLICATION_PASSWORD" \
-H "Content-Type: application/json" \
-d '{
"_dry_run": true,
"_match": { "id": 123 },
"type": "post",
"title": "Updated title"
}'

The response lists exactly what would change, plus any warnings. Remove _dry_run to actually write.

Next: The canonical document and Record identity.