Quickstart

This takes you from an API key to a finished build job. It assumes WPOS has enabled your account as a partner and issued you a key. If not, see Getting access.

The base URL for the Partner API is https://api.wpcursor.com/api/partner/v1. Authenticate every request with the X-Partner-Key header.

Check your key

Confirm the key works and see the scopes it carries.

curl https://api.wpcursor.com/api/partner/v1/ping \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY"

{
  "success": true,
  "partner": { "id": "ptr_...", "name": "Acme Agency", "slug": "acme" },
  "scopes": ["provision", "read", "handoff", "jobs", "embed"]
}

Provision a customer account

Create an account for a customer, keyed by your own reference. This call is idempotent on externalRef: send it again and you get the same account back with existing: true, never a duplicate.

curl -X POST https://api.wpcursor.com/api/partner/v1/accounts \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "owner@customer.com", "externalRef": "ws_123", "company": "Customer Co" }'

{
  "success": true,
  "existing": false,
  "account": { "id": "acc_...", "email": "owner@customer.com", "licenseKey": "WPC-...", "plan": "starter", "createdAt": "2026-08-08T..." }
}

Keep the licenseKey: your customer uses it to activate the WPOS plugin on their site.

Connect a site

Your customer installs the WPOS plugin on their WordPress site and activates it with the license key from the previous step. See Install the plugin. Once the plugin registers, the site appears on the account and you get a site.registered webhook.Read the account’s sites to get the siteId you will run jobs against:

curl https://api.wpcursor.com/api/partner/v1/accounts/acc_.../sites \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY"

Grant some credits

Build jobs consume credits. Grant the account a balance to work from.

curl -X POST https://api.wpcursor.com/api/partner/v1/accounts/acc_.../credits \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 500, "reason": "Onboarding grant" }'

Run a build job

Submit a plain-language instruction for the agent to run on the site. The call returns immediately with a job you poll.

curl -X POST https://api.wpcursor.com/api/partner/v1/sites/site_.../jobs \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "instructions": "Add a testimonials section to the homepage with three quotes.", "externalRef": "job_001" }'

{ "success": true, "job": { "id": "job_...", "status": "queued", "pollUrl": "/api/partner/v1/jobs/job_..." } }

Poll for the result

Poll the job until it reaches a terminal status. A finished job carries a structured summary of what changed.

curl https://api.wpcursor.com/api/partner/v1/jobs/job_... \
  -H "X-Partner-Key: $WPOS_PARTNER_KEY"

{
  "success": true,
  "job": {
    "id": "job_...",
    "status": "succeeded",
    "result": {
      "summary": "Added a testimonials section with three quotes to the homepage.",
      "changes": [{ "type": "page_updated", "pageId": 12, "url": "https://customer.com/", "title": "Home" }],
      "warnings": []
    },
    "creditsConsumed": 4
  }
}

Instead of polling, you can register a webhook and receive a job.completed event the moment it finishes.

Prefer webhooks to tight polling loops. Poll at a human pace (every few seconds) for interactive flows, and lean on the job.completed webhook for everything else.

Accounts

Plans, credits, status, and sites in depth.

Build jobs

Instructions, context, results, and caps.

Embed the assistant

Put the agent inside your own product.

API reference

Every endpoint, error, and limit.

Overview

Get started

Guides

Reference

Next

Accounts

Build jobs

Embed the assistant

API reference

​Next

Accounts

Build jobs

Embed the assistant

API reference

Next