WeInc API reference

get /clients

List clients

curl -X GET "https://my.we.inc/api/v1/clients" \
  -H "Authorization: Bearer wk_your_key_here"

post /clients

Create a client

curl -X POST "https://my.we.inc/api/v1/clients" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /clients/{clientId}

Get client details

curl -X GET "https://my.we.inc/api/v1/clients/{clientId}" \
  -H "Authorization: Bearer wk_your_key_here"

patch /clients/{clientId}

Update a client

curl -X PATCH "https://my.we.inc/api/v1/clients/{clientId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects

List projects

curl -X GET "https://my.we.inc/api/v1/projects" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects

Create a project for a client

curl -X POST "https://my.we.inc/api/v1/projects" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}

Get project details

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}" \
  -H "Authorization: Bearer wk_your_key_here"

patch /projects/{projectId}

Update a project

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}

Delete a project

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /templates

List org templates

curl -X GET "https://my.we.inc/api/v1/templates" \
  -H "Authorization: Bearer wk_your_key_here"

post /templates

Create a template

curl -X POST "https://my.we.inc/api/v1/templates" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /templates/{templateId}

Get template details

curl -X GET "https://my.we.inc/api/v1/templates/{templateId}" \
  -H "Authorization: Bearer wk_your_key_here"

patch /templates/{templateId}

Update a template

curl -X PATCH "https://my.we.inc/api/v1/templates/{templateId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /templates/{templateId}

Delete a template

curl -X DELETE "https://my.we.inc/api/v1/templates/{templateId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /plans

List client plans

curl -X GET "https://my.we.inc/api/v1/plans" \
  -H "Authorization: Bearer wk_your_key_here"

post /plans

Create a client plan

curl -X POST "https://my.we.inc/api/v1/plans" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /plans/{planId}

Get plan details

curl -X GET "https://my.we.inc/api/v1/plans/{planId}" \
  -H "Authorization: Bearer wk_your_key_here"

patch /plans/{planId}

Update a plan

curl -X PATCH "https://my.we.inc/api/v1/plans/{planId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /analytics

Get aggregated analytics

curl -X GET "https://my.we.inc/api/v1/analytics" \
  -H "Authorization: Bearer wk_your_key_here"

get /webhooks

List webhook endpoints

curl -X GET "https://my.we.inc/api/v1/webhooks" \
  -H "Authorization: Bearer wk_your_key_here"

post /webhooks

Register a webhook endpoint

The webhook secret is returned only in the creation response. Store it securely to verify webhook signatures.

curl -X POST "https://my.we.inc/api/v1/webhooks" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /webhooks/{webhookId}

Get webhook details

curl -X GET "https://my.we.inc/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer wk_your_key_here"

patch /webhooks/{webhookId}

Update a webhook

curl -X PATCH "https://my.we.inc/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /webhooks/{webhookId}

Delete a webhook

curl -X DELETE "https://my.we.inc/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/chat

Run an AI turn

Send a build or change instruction to the AI for one project, exactly as the builder chat does (same prompts, same credit charge, files saved on our servers). With `async: true` returns 202 + turnId immediately; poll GET /projects/{projectId}/turns/{turnId}. With `wait: true` holds up to ~85s and returns the finished turn, else 202. Without either, streams the raw builder output as text. An org API key needs `write` and may only act on its clients' projects. 402 codes: `insufficient_credits`, `org_credit_cap`, `client_credit_cap`, `needs_trial`.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/chat" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}/turns/{turnId}

Get an AI turn

Poll a turn started with POST /projects/{projectId}/chat. `status` moves from running to completed or failed; a completed turn carries the AI's summary, the files it changed and the credits it settled at. Kept for 3 days.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/turns/{turnId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/deploy

Get deploy status

Poll a deploy started with POST /projects/{projectId}/deploy. Each poll advances the job; when the build completes this call publishes it and returns `ready` with the live `url`. Errors carry `stage` (install, build, publish, timeout) and a message.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/deploy" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/deploy

Deploy a project

Build the project's current files on our build service and publish it to its live URL (and its connected custom domain). Returns 202 with a jobId; poll GET /projects/{projectId}/deploy?job=… every 3-5 seconds until status is `ready` (with `url`) or `error`.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/deploy" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}/products

List store products

Every product in the project's store, any status, with its variants (prices in cents, stock counts).

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/products" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/products

Bulk upsert store products

Create or update up to 200 products in one call. Each product matches an existing one by handle (given or derived from the title), then by any variant SKU; variants match by SKU, then title. Returns one result per item (created, updated or error with the reason); one bad item never fails the rest.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/products" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

patch /projects/{projectId}/products

Update stock levels

Set absolute stock counts for up to 500 variants, each named by sku or variant_id. Setting a count turns stock tracking on unless track_inventory is false. Returns one result per update.

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}/products" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/products

Delete store products

Delete products (and their variants) by id or handle, up to 200 per call. Returns which ids were deleted and which were not found.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/products" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

post /clients/{clientId}/activate

Send a client invitation

Send (or re-send) the client's invitation email. The client signs in or signs up, verifies their email and accepts; only then is their account linked to your organization and can you create projects for them. Accounts are never created or linked on the client's behalf. The response is the same whether or not the address already has a WeInc account; poll GET /clients/{clientId} until status is active.

curl -X POST "https://my.we.inc/api/v1/clients/{clientId}/activate" \
  -H "Authorization: Bearer wk_your_key_here"

get /usage

Get AI credit usage

AI credits used by your clients on your organization's projects, per client and per project, over a date range (default: this UTC month so far, at most 366 days). Each client also shows its monthly_credit_cap. Set or clear a cap with PATCH /clients/{clientId} { monthly_credit_cap }.

curl -X GET "https://my.we.inc/api/v1/usage" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/orders

List store orders

The client site's storefront orders, newest first, with line items. Filter by status and a created_at range; page with limit (max 100) and offset. Amounts are in minor units (cents). Not the same as GET /orders, which lists your organization's own plan sales.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/orders" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/orders/{orderId}

Get a store order

One storefront order with its line items, customer, shipping address and totals (cents).

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/orders/{orderId}" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/store/orders/{orderId}/cancel

Cancel an unpaid store order

Cancel a pending (unpaid) order, such as a bank debit that will not complete, and send store.order.canceled. Paid orders cannot be canceled through the API (409 order_paid); the store owner handles those in their own Stripe dashboard.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/store/orders/{orderId}/cancel" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/customers

List store customers

The site's shoppers, one per email, with order count and total spent (cents). Filter by exact email; page with limit (max 100) and offset.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/customers" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/files

List project files

The project's source files as paths and sizes. ?path=src/App.tsx returns one file's content; ?include=content returns every file with its content.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/files" \
  -H "Authorization: Bearer wk_your_key_here"

patch /projects/{projectId}/files

Write project files

Write or delete source files without an AI turn, so no credits are used. Body { files: { path: content | null } } (null deletes); other files are untouched. Up to 200 files and 1 MB per file per call. The current files are saved first as a restorable snapshot (snapshotId). The builder's own save guards apply. Deploy afterwards to go live. Org API key with write permission.

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}/files" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

put /projects/{projectId}/files

Replace project files

Same as PATCH /projects/{projectId}/files (writes the listed files, deletes those set to null, keeps the rest); offered for clients that only send PUT.

curl -X PUT "https://my.we.inc/api/v1/projects/{projectId}/files" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

post /projects/{projectId}/estimate

Estimate an AI turn's credits

A credit range (low/typical/high = 25th/50th/90th percentile) for the next AI turn on this project, from what similar turns actually settled at: this project's own edits when it has at least 5, otherwise recent turns across the platform (first builds: first turns of new projects). It is an estimate, not a quote. upfrontHold is what must be available when a turn starts.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/estimate" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}/export

Export a project

One JSON document with the project's source files, store products, orders and customers (up to 10,000 each) and the rows of its WeInc Cloud database tables (up to 200 rows per table, 50 tables; `truncated` marks a cut). Internal, account and credential tables and secret-looking columns (password, hash, secret, token…) are left out.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/export" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/transfer

Transfer a project to another client

Move the project, with its conversations, history, store and Cloud backend, to another of your clients who has an account and isn't removed, suspended or churned. Connected-service credentials, purchases and credit history stay with the old owner (reconnect integrations after a transfer). Org API key with write permission.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/transfer" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}/cloud/roles

List site roles

The generated site's roles (e.g. staff, manager), each with per-table permissions and member user ids. WeInc Cloud enforces them on every data call; a site with no roles behaves exactly as before.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/cloud/roles" \
  -H "Authorization: Bearer wk_your_key_here"

put /projects/{projectId}/cloud/roles/{role}

Create or replace a site role

Define a role and its per-table permissions (read, insert, update, delete). On a table with any role permissions, a role's read/update/delete reach every member's rows, and only roles with insert (or a site admin) may add rows; everyone keeps their own rows. Optional write rules per table: columns (fields the role may write) and values ({ field: [allowed values] }); a write must fit the rules of one role that grants it, and a refused write gets 403. The reserved role "member" holds rules only, for everyone without a granting role. Up to 20 roles per site, 100 tables per role.

curl -X PUT "https://my.we.inc/api/v1/projects/{projectId}/cloud/roles/{role}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/cloud/roles/{role}

Delete a site role

Remove a role, its table permissions and every member's assignment. Tables left without role permissions return to the default rules.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/cloud/roles/{role}" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/cloud/roles/{role}/members

Give a site member a role

Assign an existing role to someone who signed up on the generated site, by email or by site user id. The account must already exist on the site.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/cloud/roles/{role}/members" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/cloud/roles/{role}/members/{userId}

Take a role from a site member

Remove a role from one site member. Their own rows stay theirs; only the role's wider access is gone.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/cloud/roles/{role}/members/{userId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/domains

List project domains

The project's custom domains and its subdomain, each with its verification status and the DNS records the domain owner must add.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/domains" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/domains

Connect a domain

Connect a custom domain ({ domain }) or a subdomain ({ subdomain }). Returns the DNS records to add. A root domain needs wwwFallback: true to connect its www form. When your org API key adds it to one of your clients' projects, your client settings decide whether custom domains are allowed (no WeInc plan needed), up to 100 custom domains per organization. Sandbox projects cannot have domains.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/domains" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/domains

Remove a domain

Remove a custom domain or subdomain from the project (?domain=www.example.com), including its routing and Cloudflare hostname cleanup, exactly as the builder does. Live org keys only, for your clients' projects; test keys cannot add or remove domains.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/domains" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/connect

Get Stripe payments status

The store's Stripe account status, refreshed from Stripe: whether onboarding is complete and charges are enabled.

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/connect" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/store/connect

Start Stripe payments onboarding

Returns a Stripe-hosted onboarding link (url) for the merchant. This is the one manual step in a headless store: the merchant opens it and completes Stripe's form; no WeInc login is needed. Links expire within minutes, so create one when the merchant is ready. Sandbox projects onboard in Stripe test mode.

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/store/connect" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

get /projects/{projectId}/store/discounts

List discount codes

Every discount code of the project's store, as the builder's Store panel shows them. Money is in minor units (cents).

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/discounts" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/store/discounts

Create a discount code

Create a discount code with the same fields and validation as the builder's Store panel. Money is in minor units (cents).

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/store/discounts" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

patch /projects/{projectId}/store/discounts/{itemId}

Update a discount code

Change any of a discount code's fields; the rest stay as they are. Validated like creation.

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}/store/discounts/{itemId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/store/discounts/{itemId}

Delete a discount code

Remove a discount code from the store. Orders already placed keep the amounts they were charged.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/store/discounts/{itemId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/shipping-rates

List shipping rates

Every shipping rate of the project's store, as the builder's Store panel shows them. Money is in minor units (cents).

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/shipping-rates" \
  -H "Authorization: Bearer wk_your_key_here"

post /projects/{projectId}/store/shipping-rates

Create a shipping rate

Create a shipping rate with the same fields and validation as the builder's Store panel. Money is in minor units (cents).

curl -X POST "https://my.we.inc/api/v1/projects/{projectId}/store/shipping-rates" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

patch /projects/{projectId}/store/shipping-rates/{itemId}

Update a shipping rate

Change any of a shipping rate's fields; the rest stay as they are. Validated like creation.

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}/store/shipping-rates/{itemId}" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'

delete /projects/{projectId}/store/shipping-rates/{itemId}

Delete a shipping rate

Remove a shipping rate from the store. Orders already placed keep the amounts they were charged.

curl -X DELETE "https://my.we.inc/api/v1/projects/{projectId}/store/shipping-rates/{itemId}" \
  -H "Authorization: Bearer wk_your_key_here"

get /projects/{projectId}/store/settings

Get store settings

Currency, automatic tax, whether checkout is open, and the Stripe account status (null settings when the store has never been set up).

curl -X GET "https://my.we.inc/api/v1/projects/{projectId}/store/settings" \
  -H "Authorization: Bearer wk_your_key_here"

patch /projects/{projectId}/store/settings

Update store settings

Set currency (an ISO 4217 code Stripe supports; on a store with products it needs confirm_currency_change: true, because prices are relabelled, not converted), tax_enabled (Stripe automatic tax) and checkout_open (true = active, false = disabled), or store_status directly.

curl -X PATCH "https://my.we.inc/api/v1/projects/{projectId}/store/settings" \
  -H "Authorization: Bearer wk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ … }'