@vibiz/cli 0.3.8 → 0.3.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -848,6 +848,15 @@ var Vibiz = class {
|
|
|
848
848
|
connections: () => this.request("/search/connections"),
|
|
849
849
|
/** Owner: Google's consent page to connect a Google account (open `url` in a browser). */
|
|
850
850
|
connectGoogle: () => this.request("/search/google/connect", { method: "POST" }),
|
|
851
|
+
/**
|
|
852
|
+
* Owner: a Google service-account key (the JSON file, as text or parsed),
|
|
853
|
+
* so nobody signs in with Google. `owner_email` is added as an owner of
|
|
854
|
+
* every site, so they show in that person's own Search Console.
|
|
855
|
+
*/
|
|
856
|
+
addGoogleKey: (key, opts = {}) => this.request("/search/google/key", {
|
|
857
|
+
method: "POST",
|
|
858
|
+
body: { key, ...opts }
|
|
859
|
+
}),
|
|
851
860
|
/** Owner: the Bing Webmaster API key, for every project. */
|
|
852
861
|
connectBing: (apiKey) => this.request("/search/bing", {
|
|
853
862
|
method: "POST",
|
|
@@ -1934,7 +1943,7 @@ function formatMinor(minor, currency) {
|
|
|
1934
1943
|
}
|
|
1935
1944
|
|
|
1936
1945
|
// packages/sdk/src/one-key.ts
|
|
1937
|
-
var APP_SDK_VERSION = "0.3.
|
|
1946
|
+
var APP_SDK_VERSION = "0.3.9";
|
|
1938
1947
|
var ONE_KEY_GIVES = "database, sign-in, email and inbox, AI models, files, payments, analytics with session replays, web data, social, phone and connectors";
|
|
1939
1948
|
function oneKeyMessage(url, host) {
|
|
1940
1949
|
const where = host ?? "your host";
|
|
@@ -10,7 +10,7 @@ import {
|
|
|
10
10
|
deployFiles,
|
|
11
11
|
oneKeyMessage,
|
|
12
12
|
writeEnvFile
|
|
13
|
-
} from "./chunk-
|
|
13
|
+
} from "./chunk-P5FM76IE.js";
|
|
14
14
|
|
|
15
15
|
// packages/docs/src/generated/content.ts
|
|
16
16
|
var PAGES = [
|
|
@@ -39,7 +39,7 @@ var PAGES = [
|
|
|
39
39
|
"section": "Getting started",
|
|
40
40
|
"order": 25,
|
|
41
41
|
"topic": null,
|
|
42
|
-
"body": "Every thelastapi service works on its own. The app doesn't have to be deployed on thelastapi: it can run on another host, be a plain HTML site, a mobile app's backend, a cron job or a script. A project is just the services you pick, and none of them needs `hosting`.\n\n## Three steps\n\n1. **Create a project with only what you need.** `vibiz init <name> --resources <one>` (MCP: `vibiz_create_project { name, resources: [\"auth\"] }`). Payments, files, web data, social, company and connectors need no resource: `--resources none` (or naming them, `--resources payments`, makes the same empty project).\n2. **Add the app's domain as running elsewhere**: `vibiz domains add app.example.com --elsewhere`. From a Limited key, analytics counts it at once and sign-in trusts it once its TXT record (`trust_record`, `_vibiz.app.example.com`) is in and `vibiz domains verify app.example.com` finds it, or the owner confirms it in the console. Sign-in trusts it, analytics counts visits from it, and payment events may be sent to it. Not needed for a script or a server with no web address.\n3. **Give the app its key: one key = everything.** One secret, `VIBIZ_APP_KEY`, reaches everything the project has: database, sign-in, email and inbox, AI models, files, payments, analytics with session replays, web data, social, phone and connectors. An owner copies it from the console and puts it in the host. An agent (or `vibiz app-key`, `vibiz connect`) gives them the exact link that opens it ready to copy (`app_key_console_url` from `vibiz_project_env`), never directions, in these words:\n\n > Add one key to Vercel and your app can use everything on thelastapi (database, sign-in, email and inbox, AI models, files, payments, analytics with session replays, web data, social, phone and connectors): copy VIBIZ_APP_KEY here: https://app.vibiz.app/projects/prj_\u2026/settings?key=production , paste it into Vercel's production environment variables, and redeploy. Or connect Vercel once (`vibiz hosts add vercel <app>`) and thelastapi keeps every variable in sync.\n\n The app loads the rest at boot:\n\n```ts\nimport { vibiz } from '@vibiz/app';\nawait vibiz.loadEnv(); // DATABASE_URL, VIBIZ_AUTH_*, VIBIZ_WEBHOOK_SECRET\u2026 into process.env\n```\n\nAny language: `npx @vibiz/cli run -- <start command>`. A build step or CI: `npx @vibiz/cli env pull --format dotenv -o .env.production`. A connected host (`vibiz hosts add <host> <app>`) gets the values written for it instead. For local work, `vibiz dev` writes the development copy (its own key, no production data) to `.env.development.local`.\n\n## Every website gets the SDK\n\nAn agent working on a website or web app that belongs to a thelastapi project (a `vibiz.json` in its folder, or one it made with `vibiz init`) always installs `@vibiz/app` pinned exactly (`npm install --save-exact @vibiz/app@0.3.
|
|
42
|
+
"body": "Every thelastapi service works on its own. The app doesn't have to be deployed on thelastapi: it can run on another host, be a plain HTML site, a mobile app's backend, a cron job or a script. A project is just the services you pick, and none of them needs `hosting`.\n\n## Three steps\n\n1. **Create a project with only what you need.** `vibiz init <name> --resources <one>` (MCP: `vibiz_create_project { name, resources: [\"auth\"] }`). Payments, files, web data, social, company and connectors need no resource: `--resources none` (or naming them, `--resources payments`, makes the same empty project).\n2. **Add the app's domain as running elsewhere**: `vibiz domains add app.example.com --elsewhere`. From a Limited key, analytics counts it at once and sign-in trusts it once its TXT record (`trust_record`, `_vibiz.app.example.com`) is in and `vibiz domains verify app.example.com` finds it, or the owner confirms it in the console. Sign-in trusts it, analytics counts visits from it, and payment events may be sent to it. Not needed for a script or a server with no web address.\n3. **Give the app its key: one key = everything.** One secret, `VIBIZ_APP_KEY`, reaches everything the project has: database, sign-in, email and inbox, AI models, files, payments, analytics with session replays, web data, social, phone and connectors. An owner copies it from the console and puts it in the host. An agent (or `vibiz app-key`, `vibiz connect`) gives them the exact link that opens it ready to copy (`app_key_console_url` from `vibiz_project_env`), never directions, in these words:\n\n > Add one key to Vercel and your app can use everything on thelastapi (database, sign-in, email and inbox, AI models, files, payments, analytics with session replays, web data, social, phone and connectors): copy VIBIZ_APP_KEY here: https://app.vibiz.app/projects/prj_\u2026/settings?key=production , paste it into Vercel's production environment variables, and redeploy. Or connect Vercel once (`vibiz hosts add vercel <app>`) and thelastapi keeps every variable in sync.\n\n The app loads the rest at boot:\n\n```ts\nimport { vibiz } from '@vibiz/app';\nawait vibiz.loadEnv(); // DATABASE_URL, VIBIZ_AUTH_*, VIBIZ_WEBHOOK_SECRET\u2026 into process.env\n```\n\nAny language: `npx @vibiz/cli run -- <start command>`. A build step or CI: `npx @vibiz/cli env pull --format dotenv -o .env.production`. A connected host (`vibiz hosts add <host> <app>`) gets the values written for it instead. For local work, `vibiz dev` writes the development copy (its own key, no production data) to `.env.development.local`.\n\n## Every website gets the SDK\n\nAn agent working on a website or web app that belongs to a thelastapi project (a `vibiz.json` in its folder, or one it made with `vibiz init`) always installs `@vibiz/app` pinned exactly (`npm install --save-exact @vibiz/app@0.3.9`), calls `await vibiz.loadEnv()` where the server starts, and adds the analytics tag with session replays on, unasked, and says it did. Secrets such as a host's token are never asked for in a chat: the agent hands over the command (`vibiz hosts add vercel <app>`), and a person types the value in their own terminal.\n\n## Per service\n\n| Service | Create with | Domain needed | The app uses it with |\n| --- | --- | --- | --- |\n| Database | `--resources database` | no | `DATABASE_URL`, plain Postgres over the internet |\n| Sign-in | `--resources auth` (brings the database) | yes, the app's web address | `VIBIZ_AUTH_*` from the env ([Sign-in](/docs/sign-in)) |\n| Payments | `--resources none` | for webhooks | `vibiz.payments.checkout(\u2026)` with any `https` `success_url` and `cancel_url`; events at the webhook URL the owner sets (`vibiz payments webhook <url>`) |\n| Email | `--resources email` | no | `vibiz.email.send(\u2026)` from `<mailbox>@<slug>.vibiz.app` |\n| Email at your own domain | `--resources none` | its own DNS | `vibiz email forward hello@example.com <inbox>` (owner), no app code |\n| AI | `--resources ai` | no | `new OpenAI(vibiz.ai)`: OpenAI-compatible, metered per call |\n| Analytics | `--resources analytics` (add `replay` too, unless the person doesn't want recordings) | yes | the tag from `vibiz analytics snippet` before `</head>`; server events with `vibiz.track(\u2026)` |\n| Session replay | `--resources replay` (brings analytics) | yes | the same tag: it records by itself (`require_consent: true` if visitors must agree first, then `vibiz('replay', 'start')`) |\n| Files | `--resources none` | no | `vibiz.files.upload(bytes, { name })` returns a permanent link |\n| Web data | `--resources none` | no | `vibiz.actions.run('web.scrape', { url })` and every other action |\n| Design | `--resources none`, or no project at all | no | `vibiz design <url> --tailwind`, or `vibiz.actions.run('web.design', { url })`: the theme and brief work in any stack |\n| Connectors | `--resources none` | no | `vibiz connectors add \u2026`; the app calls them through thelastapi with its key |\n| Social | `--resources none` | no | the owner connects accounts once (`vibiz social connect <platform>`); posts from the CLI, the console or an agent |\n| Company formation | `--resources none` | no | `vibiz company draft`, the owner files |\n\nWithout the package, every call above is an HTTP route under `/v1/app` with `Authorization: Bearer $VIBIZ_APP_KEY` ([@vibiz/app](/docs/app-sdk)).\n\n## Examples\n\nA Next.js app on another host that only takes payments:\n\n```bash\nvibiz init shop --resources none\nvibiz domains add shop.example.com --elsewhere # Limited key: then its TXT record + verify\nvibiz payments products add Pro --amount 900 --interval month --lookup-key pro-monthly\nvibiz payments webhook https://shop.example.com/api/vibiz/webhook # full-access key (production); Limited keys set development\n```\n\nOnce the domain is trusted, the live webhook defaults to `https://shop.example.com/api/vibiz/webhook` anyway; a Limited key can set a live URL on one of the project's domains with `PATCH /v1/projects/<id>/payments?env=production`.\n\n```ts\nimport { vibiz } from '@vibiz/app';\n\nconst { url } = await vibiz.payments.checkout({\n lookup_key: 'pro-monthly',\n user: session.userId,\n success_url: 'https://shop.example.com/thanks',\n cancel_url: 'https://shop.example.com/pricing',\n});\n// redirect the buyer to url; await vibiz.webhooks.receive(req) in the webhook route (only the app key needed)\n```\n\nA script that sends a daily report by email:\n\n```bash\nvibiz init reports --resources email\nVIBIZ_APP_KEY=vz_app_\u2026 node report.mjs\n```\n\n```js\nimport { vibiz } from '@vibiz/app';\nawait vibiz.email.send({ to: 'team@example.com', subject: 'Daily report', text: body });\n```\n\nA plain HTML site with analytics: `vibiz init mysite --resources analytics`, `vibiz domains add mysite.com --elsewhere`, then paste `vibiz analytics snippet` before `</head>` ([Analytics](/docs/analytics)).\n\n## Limits\n\nThe app runs under the account's caps wherever it is hosted: $5 daily spend per account, $1 AI budget per project per day, 50 app emails per project per day, and the rest in [Usage \u25B8 Limits](/docs/usage#limits). The owner raises them in the console (Billing \u25B8 Daily safety cap, the project \u25B8 AI \u25B8 Daily AI budget) or with `PATCH /v1/billing {\"daily_spend_limit_usd\": 50}` and `PATCH /v1/projects/<id>/ai {\"daily_budget_usd\": 10}`. Vibiz emails the owners at 80 % and 100 % of each cap and shows a banner with a link that raises it ([Limit alerts](/docs/usage#limit-alerts)). Agents building the app: tell the owner the caps and the expected daily cost, set the project budget to fit the traffic, and keep any cap the app adds under the platform's, telling the owner when it's hit.\n\n## Good to know\n\n- **The app key is a server secret.** `@vibiz/app` refuses to run in a browser. A plain site or a mobile app calls its own backend (or a small function) that holds the key; only the analytics tag's site key is public.\n- **Add every domain the app answers on.** Sign-in and analytics refuse other origins (`www.` comes with the domain). An agent may add one; sign-in trusts it once its TXT record proves it (or the owner confirms it).\n- **Payment webhooks have no default without hosting.** On thelastapi hosting events go to `https://<slug>.vibiz.app/api/vibiz/webhook` by themselves; elsewhere the owner sets the URL, or an agent sets one on a domain the owner already added. Setting it puts `VIBIZ_WEBHOOK_SECRET` in the env.\n- **Rotations follow on the next boot.** Values loaded with the key are read fresh each start; pasted values don't follow a rotation.\n- **What needs thelastapi hosting:** deploys, previews and rollback; buying a domain (it is served there at once: connect one bought elsewhere with `--elsewhere` instead); and the code in an [export](/docs/export) (the database and the env guide export without it).\n- **Add hosting later** with `vibiz add hosting`: every key is then pushed to the host by itself."
|
|
43
43
|
},
|
|
44
44
|
{
|
|
45
45
|
"slug": "keys",
|
|
@@ -192,7 +192,7 @@ var PAGES = [
|
|
|
192
192
|
"section": "Products",
|
|
193
193
|
"order": 86,
|
|
194
194
|
"topic": null,
|
|
195
|
-
"body": "Search gets a business's pages in front of search engines without anyone remembering to do it. Console \u25B8 the project \u25B8 **Search**, `vibiz search`, the `vibiz_search` tool or `GET /v1/projects/:id/search`.\n\n## After every deploy: IndexNow\n\nWhen a production deploy goes live (a build, a promote or a rollback), thelastapi reads the site's `/sitemap.xml` (every child sitemap of a sitemap index too) and sends the pages that are **new, or whose `<lastmod>` changed**, to [IndexNow](https://www.indexnow.org). IndexNow hands them to Bing, Yandex, Naver and Seznam, usually within minutes. A site with no sitemap sends its home page once.\n\n- **Nothing to set up.** IndexNow proves the site is yours with a key file at `/<key>.txt`. Every production deployment gets it, in `public/` for apps with a `package.json` (or `static/` when the app already has one), at the root for a plain static site. An app that ships its own file at that path keeps it.\n- **Own domain only.** Pages are sent for the project's first live domain. The free `<slug>.vibiz.app` address is not sent unless the owner turns on **Also send the free vibiz.app address** (`vibiz search free-address on`): half-built projects shouldn't get indexed under the shared domain, and a business that moves to its own domain later starts clean. Once a domain is live, only the domain is sent.\n- **Only what changed.** Each page is sent once, then again when its `lastmod` changes. A new domain starts the list over.\n- **Send now** (`vibiz search submit`, `POST /v1/projects/:id/search/submit`) sends without a deploy.\n\nWhen a run sends nothing, `note` says why: no own domain yet, or the key file isn't served yet (the first deploy after Search arrived adds it; deploy again).\n\nGoogle doesn't take IndexNow: it reads the sitemap, and the account's own Google Search Console (below) is how it hears about the site.\n\n## Google Search Console\n\
|
|
195
|
+
"body": "Search gets a business's pages in front of search engines without anyone remembering to do it. Console \u25B8 the project \u25B8 **Search**, `vibiz search`, the `vibiz_search` tool or `GET /v1/projects/:id/search`.\n\n## After every deploy: IndexNow\n\nWhen a production deploy goes live (a build, a promote or a rollback), thelastapi reads the site's `/sitemap.xml` (every child sitemap of a sitemap index too) and sends the pages that are **new, or whose `<lastmod>` changed**, to [IndexNow](https://www.indexnow.org). IndexNow hands them to Bing, Yandex, Naver and Seznam, usually within minutes. A site with no sitemap sends its home page once.\n\n- **Nothing to set up.** IndexNow proves the site is yours with a key file at `/<key>.txt`. Every production deployment gets it, in `public/` for apps with a `package.json` (or `static/` when the app already has one), at the root for a plain static site. An app that ships its own file at that path keeps it.\n- **Own domain only.** Pages are sent for the project's first live domain. The free `<slug>.vibiz.app` address is not sent unless the owner turns on **Also send the free vibiz.app address** (`vibiz search free-address on`): half-built projects shouldn't get indexed under the shared domain, and a business that moves to its own domain later starts clean. Once a domain is live, only the domain is sent.\n- **Only what changed.** Each page is sent once, then again when its `lastmod` changes. A new domain starts the list over.\n- **Send now** (`vibiz search submit`, `POST /v1/projects/:id/search/submit`) sends without a deploy.\n\nWhen a run sends nothing, `note` says why: no own domain yet, or the key file isn't served yet (the first deploy after Search arrived adds it; deploy again).\n\nGoogle doesn't take IndexNow: it reads the sitemap, and the account's own Google Search Console (below) is how it hears about the site.\n\n## Google Search Console\n\nAdd a **Google key** once, in console \u25B8 **Settings \u25B8 Search** (or `vibiz search connect google --key key.json --owner-email you@gmail.com`, or `POST /v1/search/google/key` with `{ key, owner_email? }`). Nobody signs in with Google:\n\n1. In [Google Cloud](https://console.cloud.google.com), pick or create a project and turn on the **Search Console API** and the **Site Verification API**.\n2. **IAM \u25B8 Service accounts \u25B8 Create service account** (any name, no roles), then **Keys \u25B8 Add key \u25B8 Create new key \u25B8 JSON**. Paste or choose that file.\n3. Optionally give your own Google email: it is added as an owner of every site, so they also appear in your own Search Console.\n\nThe key is checked with Google before it is kept (sealed, never shown again), and an API that is off is named with the link to turn it on. A key holds up to 1,000 sites; add another one when it fills up. Only the account owner adds keys.\n\nOr sign in with Google instead (**Or sign in with Google**, `POST /v1/search/google/connect`), when the Stack has a Google sign-in client set up.\n\nFrom then on, every project with a live own domain (or the free address, when it is sent) is set up in **your** Search Console, with no step of yours:\n\n1. **Proved yours.** A domain bought through thelastapi is proved with a DNS record we add to its zone, and becomes a Domain property (`sc-domain:example.com`, covering `www` and every subdomain). Any other domain, and the free address, is proved with Google's verification file (`/google<code>.html`), added to every production deployment the same way as IndexNow's key; it is verified a minute after the next production deploy goes live, and the file stays on later deploys, as Google checks again now and then.\n2. **Added** to Search Console as a property of the connected Google account.\n3. **Sitemap submitted**: `https://<domain>/sitemap.xml`, once the site serves one.\n4. **Every day**: clicks, impressions and average position by day, the top 50 searches and the top 50 pages over 28 days; and up to **200 pages a day** inspected (URL Inspection): pages never checked first, then pages whose `lastmod` changed since, then the longest ago. Each gets Google's verdict and words (`Submitted and indexed`, `Crawled - currently not indexed`, `Discovered - currently not indexed`\u2026), the last crawl, and the canonical Google chose.\n\nThe project's **Search** tab (and `GET /v1/projects/:id/search`, `vibiz search`) shows indexed and not-indexed pages, clicks, impressions and average position, a 28-day chart, the pages table and the top searches and pages. Mission Control's board shows `42 \xB7 31 idx` in the Pages cell (sitemap pages \xB7 indexed) and a **Search clicks 7d** column.\n\n**What Google won't do.** Google has no API to ask it to index an ordinary page (its Indexing API is only for job posts and livestreams), so nothing calls it. Each page Google left out links to Search Console's inspector (`google_inspect_url`), where you click **Request indexing**. Most pages get indexed without it once the sitemap is in.\n\n**Quotas.** Google allows 2,000 inspections per site per day and 600 a minute; thelastapi uses at most 200 a day per project, so big sites are covered over several days. **Sync now** (`POST /v1/projects/:id/search/sync`, `vibiz search sync`) runs the setup and the day's reading at once, 3 times per 10 minutes per project.\n\n**1,000 sites per Google account.** That's Google's limit. Connect more than one Google account (Connect another Google account) and new sites go to the one with the fewest. Disconnecting one revokes thelastapi's access at Google; its sites stay in your Search Console, and its projects move to another connected account on the next sync.\n\nWhen something fails, `google.note` says what failed, why and how to fix it: no own domain yet, the verification file waiting for the next deploy, a DNS record still spreading (tried again in 15 minutes), no sitemap, or **\"Google access was removed; connect again\"** when the permission was withdrawn in the Google account (the connection shows *Needs attention* in Settings \u25B8 Search).\n\n## Bing Webmaster\n\nOptional: IndexNow already tells Bing about new pages after every deploy. Paste your Bing Webmaster API key once (Bing Webmaster Tools \u25B8 Settings \u25B8 API access \u25B8 API Key) in **Settings \u25B8 Search** (`POST /v1/search/bing { \"api_key\" }`). Each site is then added to Bing Webmaster, proved with `BingSiteAuth.xml` (added to every production deployment once Bing gives its code), its sitemap submitted, and its clicks and impressions over 28 days read daily (`bing` in `GET /v1/projects/:id/search`). When Bing gives no code, `bing.note` says so: in Bing Webmaster Tools, **Import from Google Search Console** verifies every site in one click once Google is connected here. No URLs are sent to Bing beyond IndexNow.\n\n## The API\n\n| Call | What it does |\n|---|---|\n| `GET /v1/projects/:id/search` | `indexnow`: `host` sent, `sending_free_address`, `submit_free_address`, `key_url`, `pages_sent`, `last_sent_at`, `last_sent_count`, `note`. `google`: `connected`, `property`, `verify_method`, `verified_at`, `sitemap_submitted_at`, `last_sync_at`, `note`, `totals` (`pages_known`, `indexed`, `not_indexed`, `not_inspected`), `clicks_28d`, `impressions_28d`, `position_28d`, `daily`, `top_queries`, `top_pages`. `bing`: `connected`, `site_added_at`, `verified_at`, `clicks_28d`, `impressions_28d`, `note` |\n| `PATCH /v1/projects/:id/search` | `{ \"submit_free_address\": true }` also sends the free address while there's no own domain |\n| `POST /v1/projects/:id/search/submit` | Send new and changed pages to IndexNow now; `run` says how many, or why none |\n| `GET /v1/projects/:id/search/pages` | `?state=indexed\\|not_indexed\\|all&limit&offset`: each sitemap page as Google sees it, with `google_inspect_url` |\n| `POST /v1/projects/:id/search/sync` | Set up and read Google and Bing now |\n| `GET /v1/search/connections` | The account's Google accounts (`account_email`, `sites` of `site_limit` 1,000, `status`, `error`) and Bing key. Tokens and keys are never returned |\n| `POST /v1/search/google/connect` | Owner: `{ url }`, Google's consent page |\n| `POST /v1/search/bing` | Owner: `{ \"api_key\" }`, checked with Bing first |\n| `DELETE /v1/search/connections/:id` | Owner: disconnect a Google account or the Bing key |\n\nThe SDK has `vibiz.search.get`, `pages`, `sync`, `connections`, `connectGoogle`, `connectBing` and `disconnect`; the `vibiz_search` tool has the actions `get`, `submit`, `free_address`, `pages` and `sync`.\n\n## Running your own Stack\n\nConnecting Google needs a Google Cloud OAuth client (web application) with the **Google Search Console API** and the **Site Verification API** enabled, the scopes `openid`, `email`, `https://www.googleapis.com/auth/webmasters` and `https://www.googleapis.com/auth/siteverification` on its consent screen, and the redirect URI `<public URL>/v1/search/google/callback`. Set `VIBIZ_SEARCH_GOOGLE_CLIENT_ID` and `VIBIZ_SEARCH_GOOGLE_CLIENT_SECRET`; without them Connect Google answers `not_configured` and IndexNow keeps working."
|
|
196
196
|
},
|
|
197
197
|
{
|
|
198
198
|
"slug": "actions",
|
|
@@ -520,8 +520,10 @@ vibiz \u2014 website, database and sign-in for a new business, in one command
|
|
|
520
520
|
to Request indexing for the ones not indexed
|
|
521
521
|
vibiz search sync set up and read Google and Bing now (daily otherwise)
|
|
522
522
|
vibiz search connections the account's Google and Bing accounts
|
|
523
|
-
vibiz search connect google
|
|
524
|
-
|
|
523
|
+
vibiz search connect google --key <file.json> [--owner-email <email>]
|
|
524
|
+
add a Google key file (service account): every
|
|
525
|
+
project goes into Search Console, no sign-in
|
|
526
|
+
vibiz search connect google the link where the owner signs in with Google instead
|
|
525
527
|
Web data (billed per call; every run is kept: vibiz runs, console \u25B8 Web data)
|
|
526
528
|
vibiz scrape <url> [--json] one page as markdown
|
|
527
529
|
vibiz design <url> [--out design.md] [--tailwind] [--shadcn] [--css] [--own] [--pages /a,/b]
|
|
@@ -737,7 +739,7 @@ vibiz \u2014 website, database and sign-in for a new business, in one command
|
|
|
737
739
|
"section": "Reference",
|
|
738
740
|
"order": 10,
|
|
739
741
|
"topic": null,
|
|
740
|
-
"body": "Base URL: `https://app.vibiz.app/v1`. Authenticate with `Authorization: Bearer <key>`. Request and response bodies are JSON unless a route says otherwise; every response has an `X-Request-Id`.\n\n```bash\ncurl https://app.vibiz.app/v1/projects -H \"Authorization: Bearer $VIBIZ_API_KEY\"\n```\n\n- **Keys**: an account key (`vz_sk_\u2026`, agent or owner access), the app key (`vz_app_\u2026`) on `/v1/app/*` and `/v1/ai/*`, or a project AI key (`vz_ai_\u2026`) on `/v1/ai/*`. See [Keys and environments](/docs/keys).\n- **Environments**: project routes for payments, company, sign-in and the database take `?env=production|development`; the default is production for full-access keys and development for Limited keys.\n- **Idempotency**: any `POST` takes `Idempotency-Key` (24 hours).\n- **Errors**: `{ \"error\": { \"code\", \"message\", \"details\"? } }`. See [Errors](/docs/errors).\n- **Lists**: `{ \"object\": \"list\", \"data\": [...] }`; payments lists add `has_more` and `next_cursor`.\n- **Async work**: creating a project, adding a resource and deploying answer `202` with the queued operations; poll the object.\n\nAuth below: *account key* is any account key; *full-access key* refuses Limited keys with `403 owner_only`; *owner on production* means a Limited key may do it in development only.\n\n## Projects\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/health` | account key | Mission Control: every active project with its health, worst first: `status` (`fail`, `warn`, `ok`, `unknown`), `checked_at`, `counts`, `top` (the 3 worst problems, each with `detail`, `fix`, `link`, `since`), `metrics` (`visitors_7d`, `pageviews_24h`, `sales_30d`, `errors_24h`) and `console_url`; with `totals`. `?status=fail` (or `fail,warn`), `?q=`. Without credentials it is the liveness probe: `{ ok: true }`. |\n| `POST /v1/health/run` | account key | Check every project again now, in the background \u2192 `202` `{ queued }`. Twice per 10 minutes; checks also run hourly. |\n| `GET /v1/projects/:id/health` | account key | One project's health checks, worst first (site up, last deploy, resources, errors, traffic, sitemap & pages, payments, limits, domain), each with `detail`, `fix`, `link` and `since`. Checked on this read if it never was. |\n| `POST /v1/projects/:id/health/run` | account key | Check one project now \u2192 its checks. 5 a minute per project. |\n| `GET /v1/mission-control` | account key | Mission Control's board in one call: every active project as a row of `steps` (domain, deploy, pages, traffic, experience, payments, sales, limits; each with `status`, `set_up`, `value`, `line`, `link`; the pages step's `value` is how many pages the sitemap lists), its `metrics` (30 days of `pageviews_30d`/`visitors_30d`, `visitors_7d` and `visitors_prev_7d` with `visitors_change_pct`, sales and revenue 30 days and today, `errors_24h`, `sitemap_pages`, `indexed_pages` and `search_clicks_7d` (Google Search Console; null until the site is verified there), `ai_spend_today_usd_micro`, `top_sources_7d`, `top_pages_7d`, `last_deploy`, `latest_problem_replay`), worst first; plus `insights` (`today`, `movers`, `new_problems`, `top_sources_7d`) and the `layout`. Figures kept a minute (`metrics_at`), health fresh. |\n| `GET /v1/projects/:id/search` | account key | Where the project's pages go to search engines and what they say: `indexnow` with the `host` sent (its own domain, or the free address when turned on), `pages_sent`, `last_sent_at`, `last_sent_count`, `key_url` and a `note` when the last run sent nothing; `google` (the account's own Search Console) with `connected`, `property`, `verify_method`, `verified_at`, `sitemap_submitted_at`, `last_sync_at`, `note` (what failed, why, how to fix), `totals` (`pages_known`, `indexed`, `not_indexed`, `not_inspected`), `clicks_28d`, `impressions_28d`, `position_28d`, `daily`, `top_queries`, `top_pages`; `bing` with `connected`, `site_added_at`, `verified_at`, `clicks_28d`, `impressions_28d`, `note`. |\n| `GET /v1/projects/:id/search/pages` | account key | The sitemap's pages as Google sees them (URL Inspection, up to 200 a day): `state` `indexed`, `not_indexed` or `all` (default), `limit` (\u2264 200), `offset`. Each has `indexed`, `verdict`, `coverage_state` (Google's words), `last_crawl_time`, canonicals and `google_inspect_url`, where the owner clicks Request indexing. |\n| `POST /v1/projects/:id/search/sync` | account key | Set the site up in Google and Bing and read them now instead of waiting for the daily sync \u2192 the project search. 3 per 10 minutes per project. |\n| `GET /v1/search/connections` | account key | The account's own search engine accounts: Google Search Console (`account_email`, `sites` of `site_limit` 1,000, `status`, `error`) and Bing Webmaster. `google_available`: whether this Stack can connect Google. Tokens and keys are never returned. |\n| `POST /v1/search/google/connect` | full-access key | Connect a Google account's Search Console \u2192 `{ url }`, Google's consent page; open it in a browser. Several Google accounts can be connected (Google allows 1,000 sites each). `not_configured` when this Stack has no Google client. |\n| `POST /v1/search/bing` | full-access key | `{ api_key }`: the Bing Webmaster API key (Bing Webmaster Tools \u25B8 Settings \u25B8 API access), checked with Bing, then used for every project; replaces the previous one. |\n| `DELETE /v1/search/connections/:id` | full-access key | Disconnect a Google account (its access is revoked at Google) or the Bing key. Projects on that Google account move to another connected one on the next sync. |\n| `PATCH /v1/projects/:id/search` | account key | `{ submit_free_address }`: also send the free vibiz.app address while there is no own domain (off by default). |\n| `POST /v1/projects/:id/search/submit` | account key | Send the pages that are new or changed in the sitemap to IndexNow now; `run` has `sent` and `host`, or `note` saying why nothing went. |\n| `GET /v1/mission-control/layout` | account key | The account's pinned rows and row order on the board: `rows` of `{ project_id, pinned, position }`. |\n| `PUT /v1/mission-control/layout` | account key | Pin or order rows: `{ rows: [{ project_id, pinned, position }], replace? }`; `replace: true` drops every row not listed (Tidy up). Each project once; another account's project is `404`. |\n| `POST /v1/projects` | account key | Create a project `{ name, slug?, resources? }`. Default resources: hosting, database, auth, analytics. \u2192 `202 { project, operations }`. |\n| `GET /v1/projects` | account key | List projects, each with `url`, `primary_url` and `custom_domains`. |\n| `GET /v1/projects/metrics` | account key | Every project's revenue (30 days, net of refunds, `usd_cents` plus `by_currency` as charged) and visitors (7 days) in one call, with the account's `totals`. `?env=production\\|development` (default production). \u2192 `list` of `project_metrics`. |\n| `GET /v1/projects/:id` | account key | One project with its resources, `url` (the vibiz.app address), `primary_url` (a live own domain, else `url`) `custom_domains` (`{ domain, hosting, live }`, live first) and `public_live`. |\n| `PATCH /v1/projects/:id` | full-access key | Change a project's settings: `{ public_live: true\\|false }` shows it on the public live page or takes it off at once. \u2192 the project. |\n| `GET /v1/projects/:id/icon` | account key | The live site's favicon as a data URI (`icon`, null without one), fetched by thelastapi. |\n| `DELETE /v1/projects/:id` | account key | Site offline now; data destroyed after 7 days. `409 payments_held` while it holds live money. \u2192 `202` with `delete_after`. |\n| `POST /v1/projects/:id/restore` | account key | Undo a delete within the 7 days; what was live is rebuilt. \u2192 `202`. |\n| `POST /v1/projects/:id/resources` | account key | Add a resource `{ type }` (`hosting`, `database`, `auth`, `email`, `analytics`, `replay`, `ai`); dependencies are added. \u2192 `202`. |\n| `PATCH /v1/projects/:id/resources/:type` | account key | Change a resource's settings `{ config }` (only `replay` has settings). |\n| `GET /v1/projects/:id/env` | full-access key | The production env values. `?names=1` lists only the names, for any key. |\n| `GET /v1/projects/:id/env/vars` | account key | The app's own variables: `data[]` with `name`, `environment` and `updated_at`, never a value. |\n| `PUT /v1/projects/:id/env/:name` | owner on production \xB7 any key on development | Set one of the app's own variables `{ value, environment? }` (`production` by default): write-only, sealed, added to the env the app loads and to connected hosts. `NAME`: capitals, digits and `_`; a name thelastapi sets answers `409`. |\n| `DELETE /v1/projects/:id/env/:name` | owner on production \xB7 any key on development | Remove one of the app's own variables (`?environment=development` for the development one). |\n| `POST /v1/projects/:id/secret-link` | account key | The console link where a person types one secret `{ name, environment?, kind? }` (`env`, `connector`, `ai`, `host`): what an agent hands over instead of asking for the value in a chat. \u2192 `{ console_url }`. |\n| `GET /v1/projects/:id/domains` | account key | The free `address` and the owner's own domains: `data[]` with `status` (`pending_dns`, `verifying`, `active`, `error`, `external`), `https` and the `records_to_set` (`type`, `name`, `value`); `domains` lists the names. |\n| `POST /v1/projects/:id/domains` | account key | Connect a domain `{ domain, hosting? }` (`vibiz`: served here with HTTPS, the default with hosting; `elsewhere`: only trusted). At most 10; `409 domain_taken` if another project has it. \u2192 `201` with `domain`. |\n| `POST /v1/projects/:id/domains/:domain/verify` | account key | Check DNS and ownership again now. \u2192 the domain. |\n| `DELETE /v1/projects/:id/domains/:domain` | full-access key | Disconnect a domain (and its `www` redirect). |\n| `POST /v1/projects/:id/domains/buy` | full-access key | Buy a domain from credits for this project `{ domain, years?, expected_price_cents, confirm_premium?, contact?, save_contact?, additional? }`: registered to the saved owner details, served here at once. \u2192 `202` the owned domain. `402` short of credits, `409 price_changed` with a new quote; agents get `owner_only` with the console link. |\n| `POST /v1/domains/buy` | full-access key | Buy a domain for the account `{ domain, project_id?, years?, expected_price_cents, \u2026 }` (as the project route): on `project_id` once registered, or none to use later. \u2192 `202` the owned domain. |\n| `POST /v1/domains/:domain/use` | account key | Use a bought domain, or a name under it, on any of the account's projects `{ project_id (id or slug), name?, hosting?, points_to? }`: no DNS to set, trusted for sign-in at once. `409 in_use` (with `used_on` and the move) when another project has it. \u2192 `domain_use`. |\n| `POST /v1/domains/:domain/move` | full-access key | Move a name of a bought domain to another project `{ to_project_id, name?, from_project_id?, hosting?, points_to? }`: the old project lets go of it (and its `www`). \u2192 `domain_use` with `moved_from`. |\n| `POST /v1/domains/:domain/point` | account key | A bought name used by an app on another host: point it there `{ name?, points_to, project_id? }` (`null` clears it); we write the record in its DNS. \u2192 `domain_use`. |\n| `GET /v1/domains/search` | account key | Domains for a name `?q=` across endings, with `price_cents` and `renewal_price_cents` (USD) and a `buy_url`. |\n| `GET /v1/domains/quote` | account key | One domain `?domain=&years=&project_id=`: the price, the balance after, the owner details it still needs (`fields_needed`) and `buy_url` for the owner. |\n| `GET /v1/domains` | account key | Domains the account bought: `status`, `expires_at`, `auto_renew`, `renewal_price_cents`, `registered_to`, `used_on` (every project and name using it), `contact_verification` (`status`, `verify_by`, `can_confirm`), `last_order`. |\n| `GET /v1/domains/:domain` | account key | One bought domain. |\n| `PATCH /v1/domains/:domain` | full-access key | Turn auto-renew (from credits, ~30 days before expiry) on or off `{ auto_renew }`. |\n| `POST /v1/domains/:domain/renew` | full-access key | Renew now from credits `{ years?, expected_price_cents }` \u2192 `202`. |\n| `GET /v1/domains/:domain/records` | account key | A bought domain's DNS records: `id`, `type`, `name` (relative, `''` the domain itself), `value`, `ttl`, `priority` (MX), and `managed` / `managed_by` (`hosting`, `email`, `default`) for the ones Vibiz keeps. |\n| `POST /v1/domains/:domain/records` | full-access key | Add a record `{ type: A\\|AAAA\\|CNAME\\|MX\\|TXT\\|CAA, name, value, ttl?, priority? }` \u2192 `201` the record (`200` with `created: false` when the same one is already there). |\n| `DELETE /v1/domains/:domain/records/:id` | full-access key | Remove a record. A `managed` one answers `409 managed_record` with what to run instead, unless `?force=1`. |\n| `POST /v1/domains/:domain/contact-verification/confirm` | full-access key | Confirm the owner's contact details for a new domain (ICANN asks within 15 days) when `contact_verification.can_confirm`. \u2192 the owned domain. |\n| `POST /v1/domains/:domain/contact-verification/check` | account key | Check now whether the owner's contact details are confirmed. \u2192 the owned domain. |\n| `POST /v1/domains/:domain/auth-code` | full-access key | The transfer code another registrar asks for. |\n| `GET /v1/domains/owner` | full-access key | The domain owner details (the registrant every new domain is registered to). |\n| `PUT /v1/domains/owner` | full-access key | Save the domain owner details `{ contact }`; they apply to domains bought from then on. |\n\n## Development environment\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/dev` | account key | `{ status: none\\|provisioning\\|ready\\|failed, resources }`. |\n| `POST /v1/projects/:id/dev` | account key | Create the development copies (idempotent). \u2192 `202`. |\n| `GET /v1/projects/:id/dev/env` | account key | The development env values; `409` until ready. |\n| `DELETE /v1/projects/:id/dev` | account key | Throw the development copies away. \u2192 `202`. |\n\n## Keys and hosts\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/waitlist` | public | Join the waitlist for a new account: `{ email, source? }` \u2192 `200 { object: \"waitlist_signup\", listed: true }`, the same answer whether or not the email was already listed. 20 per address per hour. |\n| `POST /v1/cli/login` | public | Start a browser login (`vibiz login`): `{ hostname?, os?, cli_version? }` \u2192 `201 { device_code, user_code, verification_uri, verification_uri_complete, expires_in, interval }`. The person opens the link and clicks Authorize. 10 per address per 10 minutes. |\n| `POST /v1/cli/login/token` | public | Poll a browser login `{ device_code }` every `interval` seconds: `400 { error }` with `authorization_pending`, `slow_down`, `expired_token`, `access_denied` or `invalid_grant` (`authorization_pending` with `reason: signup_closed` and `waitlist_url` when the person who opened the link is not invited: stop and pass on `error_description`); once approved, `200 { api_key, key, account, api_url }`, exactly once. The key is a new Limited key named `cli \xB7 <hostname>`. |\n| `GET /v1/whoami` | account key | The account and key this request acts as: `{ account, key: { id, name, prefix, kind, access }, role }`. |\n| `POST /v1/cli/logout` | account key | The calling key revokes itself (`vibiz logout` for a key a browser login made). |\n| `GET /v1/api-keys` | account key | Named keys, no secrets, with `access`. |\n| `POST /v1/api-keys` | full-access key | Create a key `{ name, access?: owner\\|agent }` (default owner, Full access; agent is Limited). The secret is returned once. \u2192 `201`. |\n| `PATCH /v1/api-keys/:id` | full-access key | Change a key's access `{ access: owner\\|agent }` (Full access or Limited). A Limited key can't change any key, and a key can't change its own. |\n| `DELETE /v1/api-keys/:id` | full-access key | Revoke a key (a key can't revoke itself). |\n| `GET /v1/projects/:id/app-keys` | account key | App key prefixes and last use, per environment, each with the `console_url` that opens it ready to copy. |\n| `GET /v1/projects/:id/app-keys/:environment` | owner on production \xB7 any key on development | The app key itself, to paste into a host thelastapi can't connect to. A Limited key gets `owner_only` with the `console_url` to hand over. |\n| `POST /v1/projects/:id/app-keys/rotate` | owner on production \xB7 any key on development | Rotate an app key `{ environment, grace_seconds }`; the new key is pushed everywhere, never shown. |\n| `GET /v1/hosts` | account key | The hosts thelastapi can connect to and what each asks for. |\n| `GET /v1/projects/:id/hosts` | account key | Connected hosts: status and the variable names written. |\n| `POST /v1/projects/:id/hosts` | full-access key | Connect a host `{ kind, token, project?, team_id?, environments? }`; the token is checked first. \u2192 `201`. |\n| `POST /v1/projects/:id/hosts/sync` | account key | Push the env to every connected host now. \u2192 `202`. |\n| `DELETE /v1/projects/:id/hosts/:target` | full-access key | Disconnect; `?keep_values=1` leaves the values in place. |\n\n## Hosting\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/files/missing` | account key | Which of `{ shas }` (SHA-1, up to 10,000) still need uploading. |\n| `PUT /v1/files/:sha` | account key | Upload one file (raw bytes, up to 50 MB); must match its SHA-1. \u2192 `204`. |\n| `POST /v1/projects/:id/deployments` | account key | Build `{ files: [{ path, sha, size }], target? }` (`production` by default, or `preview`). \u2192 `202 { deployment, operation }`. |\n| `GET /v1/projects/:id/deployments` | account key | The latest 50 deployments. |\n| `GET /v1/deployments/:id` | account key | `status`: `queued \u2192 building \u2192 ready` or `failed`. |\n| `GET /v1/deployments/:id/files` | account key | The deployment's code as deployed: `data[]` with every file's `path`, `sha` and `size`. |\n| `GET /v1/deployments/:id/files/*` | account key | One file's bytes by its path (`/files/src/app.js`), with `x-vibiz-sha`. `404` for a path the deployment doesn't have. |\n| `GET /v1/projects/:id/versions` | account key | Version history, newest first: `data[]` with `message`, `summary`, `who`, `created_at`, `target`, `status`, `live` and `files` added, updated and deleted against the version before. `?limit=`, `?cursor=`. |\n| `GET /v1/projects/:id/versions/diff` | account key | What changed between two versions: `?to=` (default the live one) against `?from=` (default the one before). `files[]` with a unified `diff` for text and sizes for binary files; `unavailable[]` names files no longer stored, with why. |\n| `POST /v1/projects/:id/versions/:version/restore` | account key | Put a version live again: `:version` is an id or `previous`. Instant for a production version (`200`), rebuilt for a preview or a build the host no longer keeps (`202`). The database is not rolled back: the answer has a `warning` saying so. |\n| `POST /v1/deployments/:id/promote` | account key | Make it live: a production deployment switches instantly (`200`, how rollback works); a preview is rebuilt as production (`202`). |\n\n## Database and users\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/database` | owner on production \xB7 any key on development | The app database's schemas and tables. `?env=`. |\n| `GET /v1/projects/:id/database/tables/:schema/:table` | owner on production \xB7 any key on development | One table's rows, read-only. `limit` (\u2264 200), `offset`. |\n| `POST /v1/projects/:id/database/query` | owner on production \xB7 any key on development | One read-only statement `{ sql, env? }` (SELECT, WITH, TABLE, VALUES, EXPLAIN, SHOW). |\n| `GET /v1/projects/:id/users` | owner on production \xB7 any key on development | The app's signed-up users. `limit` (\u2264 100), `offset`, `search`. |\n| `POST /v1/projects/:id/users/:user/sign-out` | full-access key | End one user's sessions. |\n\n## Sign-in\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/auth/settings` | owner on production \xB7 any key on development | Sign-in settings for `?env=`: email and password, magic link, providers with callback URLs, localhost, allowed domains, sender. |\n| `PATCH /v1/projects/:id/auth/settings` | owner on production \xB7 any key on development | Change sign-in settings (partial). |\n| `PUT /v1/projects/:id/auth/providers/:provider` | owner on production \xB7 any key on development | `google`, `github`, `vercel`: `{ credentials: \"shared\" }` (Google only) or `{ credentials: \"own\", client_id, client_secret }`. |\n| `DELETE /v1/projects/:id/auth/providers/:provider` | owner on production \xB7 any key on development | Turn a provider off. |\n| `POST /v1/projects/:id/auth/test-email` | full-access key | A test message `{ to }` through the SMTP sender that is set. |\n\n## Email\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/email` | account key | The project's mail domain, status, today's sends and recent activity. |\n| `GET /v1/forwarding` | account key | Email forwarding on every domain of the account: `data[]` as `GET /v1/domains/:domain/forwarding`. |\n| `GET /v1/domains/:domain/forwarding` | account key | Email forwarding for a domain: `status` (`off`, `needs_dns`, `verifying`, `active`, `failed`), `managed_dns`, the `records` it needs, `mx` (whose mail servers it points at, with a warning when they are another provider's), `rules[]` (`address`, `to[]` with each inbox's `status`: `pending` until it confirms, `confirmed`, `disabled`), `forwarded_today`, `daily_cap`, `next_step`. |\n| `PUT /v1/domains/:domain/forwarding` | full-access key | Set every rule `{ rules: [{ address: \"hello\" \\| \"*\", to: [\"me@example.com\"] }], replace_mx? }` (up to 5 inboxes each; `*` is any other address). Domains bought through thelastapi get their records set; `replace_mx: true` confirms taking the domain's mail from the provider it uses today. New inboxes get a confirmation email. Agents get `owner_only` with a `console_url` that has their proposal filled in. |\n| `DELETE /v1/domains/:domain/forwarding` | full-access key | Turn email forwarding off for the domain and remove the records thelastapi set. |\n| `POST /v1/domains/:domain/forwarding/verify-dns` | account key | Check the domain's records again now. \u2192 the forwarding. |\n| `GET /v1/domains/:domain/forwarding/log` | account key | Recent messages to the domain's forwarding addresses (`?limit=`, \u2264 200; kept 30 days): `at`, `from`, `to`, `destination`, `subject`, `status` (`sent`, `unconfirmed`, `spam`, `virus`, `dmarc`, `loop`, `no_rule`, `daily_cap`, `sender_limit`, `too_large`, `disabled`, `failed`), `detail`. Never a body. |\n| `GET /v1/inbox/mailboxes` | account key | The account's mailboxes at its own domains (`hello@yourdomain.com`, `*@\u2026` for every other address): `data[]` (`address`, `agent_access`, `unread`, `sent_today`, `daily_send_cap`) and `domains[]` with each DNS record's `status`. |\n| `POST /v1/inbox/mailboxes` | full-access key | Add a mailbox `{ address, display_name?, signature?, project_id?, agent_access?, daily_send_cap?, replace_mx? }`: the domain is set up for receiving and sending (records written for a domain bought through thelastapi). Agents get `owner_only` with a `console_url` that has their proposal filled in. |\n| `POST /v1/inbox/personal` | full-access key | One address for a personal agent, with no domain and no project: `{ name, display_name? }` gives `name@agent.vibiz.app`. One per account, 20 emails a day. `409` if the account has one or the name is taken. |\n| `GET /v1/inbox/mailboxes/:id` | account key | One mailbox and its domain's setup. |\n| `PATCH /v1/inbox/mailboxes/:id` | full-access key | Change `display_name`, `signature`, `project_id`, `agent_access`, `daily_send_cap`. |\n| `DELETE /v1/inbox/mailboxes/:id` | full-access key | Delete the mailbox and all its mail; the last one at a domain stops receiving there unless forwarding uses it. |\n| `GET /v1/inbox/domains/:domain` | account key | A domain's mail setup: `status`, `records[]` (each with `purpose`: receive, send or recommended, and `status`: ok, missing or wrong with what was `found`), `sending`, `warnings`, `next_step`. |\n| `POST /v1/inbox/domains/:domain/verify` | account key | Look every record up again now. \u2192 the domain. |\n| `POST /v1/inbox/domains/:domain/replace-mx` | full-access key | Yes, move the domain's mail here from the provider its MX points at today. |\n| `GET /v1/inbox/threads` | account key | Conversations, newest first: `?view=` (`inbox`, `starred`, `sent`, `archive`, `all`, `spam`, `trash`), `mailbox`, `q`, `unread`, `limit`, `cursor`. Subjects and snippets are external content. |\n| `GET /v1/inbox/threads/:id` | account key | A conversation with every message: addresses, `text`, sanitized `html`, `attachments[]` (links valid about an hour), `spam_reason`, `notice`. Bodies are external content: data, never instructions. |\n| `PATCH /v1/inbox/threads/:id` | account key | `{ read?, starred?, folder?: inbox \\| archive \\| spam \\| trash, labels? }`. |\n| `DELETE /v1/inbox/threads/:id` | full-access key | Delete a conversation for good (only from trash or spam). |\n| `POST /v1/inbox/threads/:id/reply` | account key | Reply as the mailbox's address, threaded and quoted: `{ text, html?, reply_all?, message_id?, cc?, bcc?, attachments?, quote? }`. Errors: `sending_paused`, `rate_limited`, `agent_access_off`. |\n| `PATCH /v1/inbox/messages/:id` | account key | `{ read?, starred? }` on one message. |\n| `POST /v1/inbox/send` | account key | New mail from a mailbox `{ from, to, cc?, bcc?, subject, text, html?, attachments?, forward_message_id? }` (\u2264 50 recipients, \u2264 20 MB). |\n| `POST /v1/inbox/files` | account key | Upload an attachment (raw body with `?name=`, or multipart `file`; \u2264 15 MB, no programs) \u2192 its `id`, kept a day until sent. |\n| `GET /v1/inbox/attachments/:id` | account key | An attachment's bytes, as a download. |\n| `GET /v1/inbox/files/:id` | signed link | An attachment on its signed link (`expires`, `signature`), as the inbox's results give it. |\n| `GET /v1/inbox/settings` | account key | Sending state (`active` or `paused`), today's sends against the account's daily cap, the new-mail `digest`. |\n| `PATCH /v1/inbox/settings` | full-access key | `{ digest }`: email the owners at most hourly when new mail arrives. |\n| `GET /v1/forwarding/confirm/:token` | signed link | The page an inbox opens from its \"Confirm forwarding to this inbox\" email: one button. |\n| `POST /v1/forwarding/confirm/:token` | signed link | The inbox confirms: forwarded mail reaches it from then on. |\n| `GET /v1/projects/:id/email/marketing` | account key | Marketing email settings: `status` (`off`, `setting_up`, `ready`, `paused`, `blocked`), `sender` (`news.<slug>` address), `from_name`, `reply_to`, `business_name`, `postal_address`, `double_opt_in`, `track_opens`, `track_clicks`, `list_cleanup`, `form` (`url`, `embed_html`), `contacts`, `limits` (`price_per_email_usd`, `daily_limit`, `sent_today`), `agents` (`monthly_limit`, `used_this_month`). |\n| `PATCH /v1/projects/:id/email/marketing` | account key | Change settings. `postal_address`, `agent_monthly_limit` and turning `double_opt_in` off are the owner's. |\n| `POST /v1/projects/:id/email/marketing/setup` | account key | Set up sending (adds the email resource if needed): `202`, `status: setting_up` until the address verifies, then `ready`. |\n| `GET /v1/projects/:id/email/lists` | account key | Lists with their `subscribed` counts. |\n| `POST /v1/projects/:id/email/lists` | account key | `{ name, description?, public? }` \u2192 the list. `public` lists show on the preference page. |\n| `PATCH /v1/projects/:id/email/lists/:list` | account key | Rename or describe a list (id or name). |\n| `DELETE /v1/projects/:id/email/lists/:list` | account key | Delete a list (its contacts stay). |\n| `GET /v1/projects/:id/email/contacts/export` | account key | Contacts as CSV (`?status=`, `?list=`), with consent and properties. |\n| `GET /v1/projects/:id/email/contacts/imports` | account key | Past imports with their reports. |\n| `POST /v1/projects/:id/email/contacts/import` | account key | Import a CSV `{ csv, dry_run?, consent, lists?, fix_typos?, include_role?, update_existing? }` \u2192 a report: `new_contacts`, `updated_contacts`, `skipped` by reason, `samples`, `typo_suggestions`. `consent: true` is required to import. |\n| `GET /v1/projects/:id/email/contacts` | account key | Contacts, newest first: `?q=`, `?status=`, `?list=`, `?segment=`, `?cursor=`, `?limit=` (\u2264 200); `total`. |\n| `POST /v1/projects/:id/email/contacts` | account key | Add or update one by email `{ email, first_name?, last_name?, properties?, lists?, subscribed?, double_opt_in?, consent? }`. Never re-subscribes someone who left: they get a confirmation email (`pending`). |\n| `GET /v1/projects/:id/email/contacts/:contact` | account key | One contact (id or email) with its lists and last 20 events. |\n| `PATCH /v1/projects/:id/email/contacts/:contact` | account key | `{ first_name?, last_name?, properties?, status?: subscribed \\| unsubscribed, add_lists?, remove_lists? }`. Subscribing again by hand is the owner's. |\n| `DELETE /v1/projects/:id/email/contacts/:contact` | account key | Forget a contact. An address that unsubscribed, bounced or complained stays suppressed. |\n| `POST /v1/projects/:id/email/events` | account key | `{ email, event, properties? }`: something a contact did. Starts event automations and ends runs whose exit event it is. |\n| `GET /v1/projects/:id/email/segments` | account key | Saved segments with their `contacts` counts. |\n| `POST /v1/projects/:id/email/segments/preview` | account key | `{ filter }` \u2192 `contacts` and a sample, without saving. |\n| `POST /v1/projects/:id/email/segments` | account key | `{ name, filter: { match: all \\| any, conditions[] } }`: properties, fields, lists, events, engagement. |\n| `PATCH /v1/projects/:id/email/segments/:segment` | account key | Rename it or change its filter. |\n| `DELETE /v1/projects/:id/email/segments/:segment` | account key | Delete a segment. |\n| `POST /v1/projects/:id/email/render` | account key | Render a draft `{ subject, preview_text?, format, body, contact_id? }` as a contact gets it: `html`, `text`, `size_bytes`, `merge_tags`. |\n| `GET /v1/projects/:id/email/broadcasts` | account key | Broadcasts, newest first (`?status=`), with their stats. |\n| `POST /v1/projects/:id/email/broadcasts` | account key | A draft `{ name?, subject, preview_text?, from_local?, from_name?, reply_to?, format: markdown \\| html, body, audience: { list_id?, segment_id? } }`. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast` | account key | One broadcast: `status`, `waiting`, `recipients`, `charged_cents`, `stats` (sent, delivered, opened, clicked, bounced, complained, unsubscribed, rates, `by_mailbox`). |\n| `PATCH /v1/projects/:id/email/broadcasts/:broadcast` | account key | Edit a draft, a scheduled or a waiting-for-approval broadcast. |\n| `DELETE /v1/projects/:id/email/broadcasts/:broadcast` | account key | Delete a draft or canceled broadcast. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast/review` | account key | The checklist before sending: `ready`, `checks[]` (`ok`, `warning`, `error`), `audience`, `cost` (`total_cents`, `balance_cents`, `enough_credits`), `sending`, `preview`, `console_url`. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/test` | account key | Send a free `[Test]` copy `{ to? }` (agents: to the owners only; 20 a day). |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/send` | account key | Send now or `{ scheduled_at }`. An agent sends only within the owner's monthly allowance; otherwise `403 owner_only` with the review link. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/cancel` | account key | Stop it; nothing more goes out and the held credits are released. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/resume` | full-access key | Go on after a pause. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast/recipients` | account key | Who got it: `?status=` (`sent`, `delivered`, `opened`, `clicked`, `bounced`, `complained`, `unsubscribed`, `failed`), `?mailbox=`, `?cursor=`. |\n| `GET /v1/projects/:id/email/automations` | account key | Automations with their run counts. |\n| `POST /v1/projects/:id/email/automations` | account key | `{ name, trigger, steps[], exit_event? }`: triggers `contact_added`, `event`, `date`; steps `wait`, `email`, `condition` (`yes[]`, `no[]`), `exit`. |\n| `GET /v1/projects/:id/email/automations/:automation` | account key | One automation with `enrollments` counts and emails sent, opened, clicked. |\n| `PATCH /v1/projects/:id/email/automations/:automation` | account key | Edit. While active only email wording changes; pause it to change the trigger, waits or branches. |\n| `DELETE /v1/projects/:id/email/automations/:automation` | account key | Delete it (archived if it sent email). |\n| `POST /v1/projects/:id/email/automations/:automation/activate` | account key | Turn it on. An agent needs the owner's monthly allowance; otherwise `403 owner_only` with the console link. |\n| `POST /v1/projects/:id/email/automations/:automation/pause` | account key | Pause it; runs wait where they are. |\n| `GET /v1/projects/:id/email/automations/:automation/enrollments` | account key | Runs: `?status=` (`active`, `completed`, `exited`, `failed`), each with its `step_id`, `next_run_at`, `history`. |\n| `POST /v1/projects/:id/email/automations/:automation/test` | account key | Send one email step as a free test `{ step_id, to? }`. |\n| `GET /v1/email/u/:token` | signed link | The unsubscribe page a contact opens from an email (`?view=preferences`: lists to keep). GET changes nothing. |\n| `POST /v1/email/u/:token` | signed link | One-click unsubscribe (`List-Unsubscribe=One-Click`, RFC 8058), or the page's form: unsubscribe, subscribe again, save lists, never from anyone. |\n| `GET /v1/email/confirm/:token` | signed link | The double opt-in page: one button. |\n| `POST /v1/email/confirm/:token` | signed link | The contact confirms: `subscribed`. |\n| `GET /v1/email/k/:token` | signed link | \"Keep sending\" page from the list-cleanup email. |\n| `POST /v1/email/k/:token` | signed link | The contact keeps getting emails. |\n| `GET /v1/email/o/:token` | signed link | Open tracking pixel. |\n| `GET /v1/email/c/:token` | signed link | Click tracking: redirects to the signed destination. |\n| `GET /v1/email/f/:form` | public | The hosted signup form. |\n| `POST /v1/email/f/:form` | public | A signup from the form, a pasted snippet or JSON from any site `{ email, first_name? }`: honeypot, rate limits, double opt-in. |\n| `OPTIONS /v1/email/f/:form` | public | CORS preflight for the signup API. |\n\n## AI\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/ai/chat/completions` | account, project AI or app key | OpenAI chat completions, streaming (SSE) or not. `model` defaults to `vibiz/fast`. |\n| `POST /v1/ai/embeddings` | account, project AI or app key | Embeddings. |\n| `POST /v1/ai/images/generations` | account, project AI or app key | Images: `b64_json` (default) or `url` (24 h). |\n| `POST /v1/ai/audio/speech` | account, project AI or app key | Text to speech; streams `mp3` or `pcm`. |\n| `POST /v1/ai/audio/transcriptions` | account, project AI or app key | Speech to text, multipart `file` (\u2264 25 MB). |\n| `POST /v1/ai/jobs` | account, project AI or app key | Async image or video `{ type, model?, input }`. \u2192 `202`. |\n| `GET /v1/ai/jobs/:id` | account, project AI or app key | A job and, once done, its output. |\n| `POST /v1/ai/jobs/:id/cancel` | account, project AI or app key | Cancel a job. |\n| `GET /v1/ai/models` | public | The thelastapi models, each with the lab model it runs, and the lab models, with prices. `?all=1` every model, `?q=` search. |\n| `GET /v1/ai/health` | public | Per capability `ok`/`degraded`/`down`. |\n| `GET /v1/ai/media/:token` | signed link | Generated media; the token in the link is the credential (24 h). |\n| `GET /v1/projects/:id/ai` | account key | A project's AI key status, budgets, limits and today's spend. |\n| `PATCH /v1/projects/:id/ai` | account key | `{ daily_budget_usd?, end_user_daily_budget_usd?, log_content?, rpm?, tpm?, concurrency? }`. |\n| `POST /v1/projects/:id/ai/keys/rotate` | full-access key | A new project AI key `{ grace_seconds? }` (default 3600), written to the app env. |\n| `POST /v1/projects/:id/ai/keys/revoke` | account key | Every AI key of the project stops now; rotate to get a new one. |\n| `GET /v1/ai-keys` | account key | Your own AI provider keys, the account's: status per provider (never a secret) and calls they served in 30 days. |\n| `GET /v1/ai-keys/:provider` | account key | One key: `has_key`, last 4, last used, last error, and per thelastapi model whether `your_key` or `vibiz` serves (and pays for) it. |\n| `PUT /v1/ai-keys/:provider` | full-access key | Set your own key (`google`): `{ type: \"gemini_api_key\", api_key }` or `{ type: \"vertex\", service_account, project_id?, region? }`, `use_for?`. Checked with a free call first. |\n| `PATCH /v1/ai-keys/:provider` | full-access key | `{ use_for: [capability\u2026] }`: what the key serves; the rest runs on thelastapi. |\n| `DELETE /v1/ai-keys/:provider` | full-access key | Remove the key; calls go back to thelastapi (jobs promised to it fail). |\n| `POST /v1/ai-keys/:provider/test` | account key | Re-check the stored key with the same free call; records the result. |\n| `GET /v1/projects/:id/ai-keys` | account key | Your own AI provider keys, a project's override (else it inherits the account's): status per provider (never a secret) and calls they served in 30 days. |\n| `GET /v1/projects/:id/ai-keys/:provider` | account key | One key: `has_key`, last 4, last used, last error, and per thelastapi model whether `your_key` or `vibiz` serves (and pays for) it. |\n| `PUT /v1/projects/:id/ai-keys/:provider` | full-access key | Set your own key (`google`): `{ type: \"gemini_api_key\", api_key }` or `{ type: \"vertex\", service_account, project_id?, region? }`, `use_for?`. Checked with a free call first. |\n| `PATCH /v1/projects/:id/ai-keys/:provider` | full-access key | `{ use_for: [capability\u2026] }`: what the key serves; the rest runs on thelastapi. |\n| `DELETE /v1/projects/:id/ai-keys/:provider` | full-access key | Remove the key; calls go back to thelastapi (jobs promised to it fail). |\n| `POST /v1/projects/:id/ai-keys/:provider/test` | account key | Re-check the stored key with the same free call; records the result. |\n| `GET /v1/projects/:id/ai/calls` | account key | The project's recent AI calls: model, tokens, cost, outcome (no content). |\n| `POST /v1/actions/ai.chat` | account key | `{ input: { prompt \\| messages, system?, model?, max_tokens?, json? } }` \u2192 `{ output: { text, model, usage }, cost_micro_usd }`. |\n| `POST /v1/projects/:id/actions/ai.chat` | account key | The same, billed to the project. |\n| `POST /v1/actions/image.generate` | account key | `{ input: { prompt, size?, n?, model? } }` \u2192 image links (24 h). |\n| `POST /v1/projects/:id/actions/image.generate` | account key | The same, billed to the project. |\n| `POST /v1/actions/speech.create` | account key | `{ input: { text, voice?, format?, model? } }` \u2192 an audio link. |\n| `POST /v1/projects/:id/actions/speech.create` | account key | The same, billed to the project. |\n| `POST /v1/actions/speech.transcribe` | account key | `{ input: { audio_base64, filename?, language?, model? } }` \u2192 `{ text, language, duration_seconds }`. |\n| `POST /v1/projects/:id/actions/speech.transcribe` | account key | The same, billed to the project. |\n\n## Files\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/files` | account key | The project's files, newest first (`env`, `type`, `source`, `q`, `since`, `until`, `model`, `tag`, `folder`, `limit`, `cursor`), with `total_files` and `total_bytes`. |\n| `POST /v1/projects/:id/files` | account key | Upload a file (raw body with `?name=`, or multipart `file`), up to 50 MB \u2192 the file with its permanent `url`. |\n| `POST /v1/projects/:id/files/import` | account key | Save what a public URL serves `{ url, name?, folder?, private? }`. |\n| `GET /v1/projects/:id/files/latest` | account key | The newest file matching `type`, `source`, `model`, `tag`: what an agent just made. |\n| `GET /v1/projects/:id/files/:fileId` | account key | One file: its link, type, size, dimensions and, for AI media, the model, prompt and cost. |\n| `GET /v1/projects/:id/files/:fileId/content` | account key | The file's bytes, private or not. |\n| `PATCH /v1/projects/:id/files/:fileId` | account key | Rename, move, tag, annotate or make private `{ name?, folder?, tags?, note?, private? }`. |\n| `DELETE /v1/projects/:id/files/:fileId` | account key | Delete a file: its link stops working. |\n\n## Export\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/projects/:id/exports` | owner on production \xB7 any key on development | Pack the project to take it elsewhere `{ include?: [code, database, database_csv, env_guide], env?, deployment_id? }` \u2192 `202` and the export, `queued`. The code is the source of the live deployment (or `deployment_id`) with `VIBIZ-EXPORT.md` and `.env.example`; the database is plain SQL that `psql` restores, CSV optional. A production database is an owner's; one export at a time, 10 a day. |\n| `GET /v1/projects/:id/exports` | account key | The last 20 exports, newest first. |\n| `GET /v1/projects/:id/exports/:exportId` | account key | One export: `status` (`queued`, `running`, `ready`, `failed`, `expired`), `step`, `progress`, and `files` with signed download links until `expires_at` (a day). Agents get no link to production data. |\n| `GET /v1/projects/:id/exports/:exportId/env` | full-access key | The export environment's secret values as a `.env` file, with `confirm=1`. Never cached, never in the zip. |\n\n## Actions\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/actions/:name` | account key | Run an account action `{ input }`: web data (`web.scrape`, `web.search`, `web.crawl`, `web.screenshot`, `web.design`, `ads.library`, `places.search`, `reviews`, `social.profile`, `social.posts`, `ecommerce.product`, `linkedin.company`; SEO data: `seo.serp`, `seo.keywords`, `seo.keyword_ideas`, `seo.domain`, `seo.backlinks`, `seo.audit`, `seo.ai_mentions`) \u2192 `{ output, cost_micro_usd, run_id, console_url }`. `web.design` with `sections: true` captures a page section by section; with `section: <n>` it reads one, free from the saved capture. |\n| `GET /v1/actions` | account key | The web data actions: name, title, one line, slow or not, a hint per field, an example and the input as JSON Schema. |\n| `GET /v1/actions/runs` | account key | Past web data runs, newest first (input, status, cost, no output). `?project=<id>\\|none`, `?action=`, `?since=<iso>`, `?cursor=`, `?limit=` (25, \u2264 100). With `console_url`. |\n| `GET /v1/actions/runs/:id` | account key | One run with its output (cut to 1 MB: `truncated`), error and cost, with `console_url`. |\n| `POST /v1/projects/:id/actions/:name` | account key | Run an action as the project (`email.send`, or any action billed to it) \u2192 `{ project_id, output, cost_micro_usd, usage }`; web data also `run_id`, `console_url`, and a screenshot is saved to the project's Files. |\n\n## Payments\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/payments` | account key | The payments account: where sales go (`account.mode`: `vibiz` or `own`), balance, payouts status, `fees` (with `hold_days` and a $100 example), webhook. |\n| `PATCH /v1/projects/:id/payments` | owner on production \xB7 any key on development | `{ statement_descriptor_suffix?, webhook_url?, webhook_events?, brand? }`. `brand` (`{ name?, logo_url?, icon_url?, background_color?, button_color?, font?, border_style? }`) is the checkout page's look for every checkout, merged field by field (a field set to null goes; `brand: null` clears it). |\n| `POST /v1/projects/:id/payments/webhook-secret` | owner on production \xB7 any key on development | Rotate the webhook secret; shown once and written to the app env as `VIBIZ_WEBHOOK_SECRET`. |\n| `GET /v1/projects/:id/payments/deliveries` | account key | The last 50 webhook deliveries and their status codes. |\n| `GET /v1/projects/:id/payments/products` | account key | The catalog for `?env=`. |\n| `POST /v1/projects/:id/payments/products` | account key | Create `{ name, description?, price?: { unit_amount_cents, currency?, type, interval?, interval_count?, lookup_key? } }` (`currency`: ISO 4217, default `usd`; amounts in its smallest unit). |\n| `GET /v1/projects/:id/payments/products/:productId` | account key | One product with its prices. |\n| `PATCH /v1/projects/:id/payments/products/:productId` | account key | Rename, describe, activate or deactivate. |\n| `DELETE /v1/projects/:id/payments/products/:productId` | owner on production \xB7 any key on development | Archive a product. |\n| `POST /v1/projects/:id/payments/products/:productId/prices` | account key | Add a price `{ unit_amount_cents, currency?, type, interval?, interval_count?, lookup_key? }`. Prices are immutable. |\n| `PATCH /v1/projects/:id/payments/prices/:priceId` | account key | `{ active?, lookup_key? }`. |\n| `POST /v1/projects/:id/payments/checkout` | account key | A hosted checkout `{ price_id \\| lookup_key \\| amount_cents+name(+currency), user?, success_url, cancel_url, brand?, \u2026 }` \u2192 `{ url, expires_at }` (1 h, one buyer). |\n| `GET /v1/projects/:id/payments/payments` | account key | Payments, newest first (`cursor`, `limit`); emails masked for agents on production. |\n| `GET /v1/projects/:id/payments/payments/:paymentId` | account key | One payment. |\n| `POST /v1/projects/:id/payments/payments/:paymentId/refund` | owner on production \xB7 any key on development | `{ amount_cents?, reason? }`; `409 insufficient_balance` when the balance can't cover it. |\n| `GET /v1/projects/:id/payments/subscriptions` | account key | Subscriptions, `?user=&status=`, each with its price. |\n| `POST /v1/projects/:id/payments/subscriptions/:subId/cancel` | owner on production \xB7 any key on development | `{ at_period_end? = true }`. |\n| `GET /v1/projects/:id/payments/ledger` | account key | Every money movement, newest first. |\n| `POST /v1/projects/:id/payments/payouts/session` | owner on production \xB7 any key on development | A session for the embedded identity, bank and payouts UI (Get paid). |\n| `POST /v1/projects/:id/payments/withdraw` | owner on production \xB7 any key on development | `{ amount_cents? }` (default everything available) \u2192 a withdrawal; `409` when payouts are not ready or nothing is available. |\n| `GET /v1/projects/:id/payments/withdrawals` | account key | Withdrawals and their status. |\n| `GET /v1/projects/:id/payments/revenue` | account key | What sales brought in over the last `days` (default 30, up to 365) and the period before, net of refunds: `usd_cents` and `by_currency`. Reads only. |\n| `POST /v1/projects/:id/payments/refresh` | account key | Re-read the account and recent charges now. |\n| `POST /v1/projects/:id/payments/simulate` | account key | Development only: `{ event: payment \\| dispute \\| refund \\| release_hold, \u2026 }` runs a real test-mode charge through the ledger and webhooks. |\n| `POST /v1/projects/:id/payments/own-account/link` | account key | A link for the owner to connect their own Stripe account instead (`?env=`, default production) \u2192 `{ url, console_url, expires_at }`. Give `url` to the owner: only they can complete it. `503` when it isn't available. |\n| `DELETE /v1/projects/:id/payments/own-account` | full-access key | Disconnect the owner\u2019s own Stripe account (or opt the project out of the Stripe account for every project): new sales go through thelastapi again, and \"Apply to all projects\" leaves it alone. |\n| `POST /v1/projects/:id/payments/own-account/use-account` | owner on production \xB7 any key on development | Put the project on the Stripe account connected once for every project (Settings \u25B8 Payments), after opting out or instead of its own. `409 account_stripe_not_connected` until it is connected. |\n| `GET /v1/payments/own-account` | account key | The owner\u2019s Stripe connected once for every project: per environment (`environments.production\\|development`), `use_for_all_projects`, and how each project uses it (`account`, `other_account`, `vibiz`, `opted_out`, `not_started`). |\n| `POST /v1/payments/own-account` | full-access key | `{ use_for_all_projects }`: when on, every new project\u2019s payments start on the owner\u2019s Stripe account (in each environment where it is connected). |\n| `POST /v1/payments/own-account/link` | account key | A link for the owner to connect their Stripe account once for every project (`?env=`, default production) \u2192 `{ url, console_url, expires_at }`. Give `url` to the owner: only they can complete it. |\n| `POST /v1/payments/own-account/apply` | owner on production \xB7 any key on development | `{ env?, dry_run?, include_opted_out? }`: switch existing projects to the owner\u2019s Stripe account for new sales \u2192 `{ changed, unchanged, skipped }` (frozen, being deleted, on another Stripe account, opted out). Balances stay to withdraw; subscriptions sold through thelastapi keep billing there. `dry_run` lists without changing (any key). |\n| `DELETE /v1/payments/own-account` | full-access key | Disconnect the owner\u2019s Stripe account for every project (`?env=`): projects that used it sell through thelastapi again for new sales (`moved`); projects that connected the same Stripe account themselves keep it (`kept`). The connection is let go only when nothing uses it. |\n| `GET /v1/payments/app-store` | account key | The owner's own RevenueCat account: the projects there its keys reach (never a key), and which projects use them. |\n| `POST /v1/payments/app-store/link` | account key | A link for the owner to connect their RevenueCat account \u2192 `{ url, expires_at }`. They paste a V2 secret key on that page (never in a chat); only they can complete it. |\n| `DELETE /v1/payments/app-store/connections/:connectionId` | full-access key | Forget a RevenueCat key; the projects set up with it stop taking new store purchases (recorded ones stay). |\n| `GET /v1/projects/:id/payments/app-store` | account key | App Store and Google Play for the project (`?env=`): connected, the app set up (public SDK keys, store product ids, webhook), and `next` steps. |\n| `POST /v1/projects/:id/payments/app-store/setup` | account key | `{ ios_bundle_id?, android_package?, store_project_id? }`: create (or find) the app in the owner's RevenueCat account, mirror the catalog (a product per price with a lookup key, an entitlement per plan, a default offering), register the webhook \u2192 the public SDK key, the App Store product ids to create, and `next`. Safe to re-run. |\n| `GET /v1/projects/:id/payments/app-store/subscriptions` | account key | App Store and Google Play purchases recorded (`?env=&user=`), newest first. |\n| `GET /v1/projects/:id/payments/app-store/webhook-secret` | full-access key | The Authorization header value to paste in the RevenueCat dashboard when the webhook could not be registered for you. |\n\n## Company\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/company/catalog` | account key | States with their fees per entity type (cents), endings, industries, thelastapi fees, disclaimer. |\n| `GET /v1/projects/:id/company` | account key | The company, with `problems` and `quote` while a draft; `404` none yet. |\n| `PUT /v1/projects/:id/company` | account key | Create or replace the draft. |\n| `PATCH /v1/projects/:id/company` | account key | Change the draft (top-level keys replace). |\n| `DELETE /v1/projects/:id/company` | account key | Delete a draft (or a failed or cancelled one). |\n| `POST /v1/projects/:id/company/submit` | owner on production \xB7 any key on development | File it. Production: `{ confirm, accept_terms, expected_total_cents, expected_updated_at }`, paid from the credits (`402 payment_required` when they fall short); development: `{ accept_terms }`. |\n| `POST /v1/projects/:id/company/checkout` | full-access key | Pay a live filing by card instead: the submit body \u2192 a `billing_checkout` for exactly `quote.total_cents`; filed when the payment arrives. |\n| `POST /v1/projects/:id/company/signatures/:document` | owner on production \xB7 any key on development | A fresh signing link (`ss4`, `form_8821`). |\n| `POST /v1/projects/:id/company/actions/:actionId` | owner on production \xB7 any key on development | Answer an action: `{ names }` or `{ address }`. |\n| `GET /v1/projects/:id/company/documents/:docId` | owner on production \xB7 any key on development | A short-lived download link. |\n| `POST /v1/projects/:id/company/refresh` | account key | Re-read it from the filing partner now. |\n| `POST /v1/projects/:id/company/simulate` | account key | Development only: `{ step: formation \\| ein }`. |\n\n## Social\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/social` | account key | Overview: platforms with their limits, connected accounts, posts waiting, scheduled and failed, ad changes waiting. |\n| `GET /v1/projects/:id/social/accounts` | account key | Connected social and ad accounts (`kind`, `platform` filters). |\n| `POST /v1/projects/:id/social/connect` | account key | `{ platform, ads? }` \u2192 a link (1 h) for the owner to open: they approve it in the console, then sign in to the platform. Production unless `env=development`, which makes a test account at once and returns it. |\n| `POST /v1/projects/:id/social/accounts/refresh` | account key | Read the accounts again from the platforms. |\n| `DELETE /v1/projects/:id/social/accounts/:accountId` | owner on production \xB7 any key on development | Disconnect an account. |\n| `GET /v1/projects/:id/social/accounts/:accountId/analytics` | account key | Followers, totals and a daily series (`from`, `to`; 30 days by default). |\n| `POST /v1/projects/:id/social/media` | account key | Upload a file (raw body, its `content-type`, `?filename=`; up to 512 MB) \u2192 a URL to post with. |\n| `GET /v1/projects/:id/social/posts` | account key | Posts, newest first (`status`, `account`, `platform`, `from`, `to`, `cursor`, `limit`). |\n| `POST /v1/projects/:id/social/posts` | account key | Publish now, schedule (`schedule_at`) or draft. Production: owners send `confirm: true`; an agent's post waits for the owner (`pending_approval`). |\n| `GET /v1/projects/:id/social/posts/:postId` | account key | One post, with each account's status, link and error. |\n| `DELETE /v1/projects/:id/social/posts/:postId` | account key | Cancel a draft, a waiting or a scheduled post (a live scheduled one: owner). Published posts stay on the platforms. |\n| `POST /v1/projects/:id/social/posts/:postId/publish` | account key | Publish or schedule a draft (same rules as creating one). |\n| `POST /v1/projects/:id/social/posts/:postId/approve` | full-access key | Approve a waiting post: it goes out now or at its time (`schedule_at` to change it). |\n| `POST /v1/projects/:id/social/posts/:postId/reject` | full-access key | Reject a waiting post. |\n| `POST /v1/projects/:id/social/posts/:postId/retry` | owner on production \xB7 any key on development | Publish the failed accounts again (production: `confirm: true`). |\n| `POST /v1/projects/:id/social/posts/:postId/refresh` | account key | Read its status again from the platforms. |\n| `GET /v1/projects/:id/social/posts/:postId/analytics` | account key | Impressions, reach, likes, comments, shares, saves, clicks per account. |\n| `GET /v1/projects/:id/social/ads/campaigns` | account key | Campaigns of an ad account with budget and spend (`account`, `ad_account`, `from`, `to`). |\n| `POST /v1/projects/:id/social/ads/changes` | account key | Boost a post, pause, resume or re-budget a campaign, or create a Google Ads campaign (`kind: create_campaign`, created paused). Production: owners send `confirm: true`; an agent's change waits for the owner. |\n| `GET /v1/projects/:id/social/ads/changes` | account key | Ad changes, newest first (`status`). |\n| `GET /v1/projects/:id/social/ads/changes/:changeId` | account key | One ad change. |\n| `POST /v1/projects/:id/social/ads/changes/:changeId/approve` | full-access key | Approve a waiting ad change: it is applied. |\n| `POST /v1/projects/:id/social/ads/changes/:changeId/reject` | full-access key | Reject a waiting ad change. |\n| `GET /v1/social-connect/:token` | signed link | The connect link: the owner's connect page in the console, then the platform's sign-in. |\n| `GET /v1/social-media/:ref` | public | An uploaded file, as the platforms fetch it. |\n\n## Phone\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/phone/search` | account key | US numbers for sale (`area_code`, `state`, `type`, `limit`), in our price. |\n| `GET /v1/phone/quote` | account key | What one `number` costs, the balance after, and what sending from it takes. |\n| `POST /v1/phone/numbers/buy` | full-access key | Buy from credits, confirming `expected_price_cents`. `project_id` optional. |\n| `GET /v1/phone/numbers` | account key | The account's numbers, with `sending_status`, `can_send`, `can_call` and the next step. |\n| `GET /v1/phone/numbers/:number` | account key | One number, by the number or its id. |\n| `POST /v1/phone/numbers/:number/assign` | full-access key | Put it on a project, or off one (`project_id: null`). |\n| `POST /v1/phone/numbers/:number/release` | full-access key | Give it up for good, with the number typed again in `confirm_number`. |\n| `GET /v1/phone/numbers/:number/registration` | account key | What registering this number for texting asks for and costs. |\n| `POST /v1/phone/numbers/:number/registration` | full-access key | Submit the business's details for carriers' review, confirming `expected_fee_cents`. |\n| `POST /v1/phone/messages` | account key | Send one text to one US number. Only from an approved number. A Limited key can only answer people who texted first. |\n| `GET /v1/phone/messages` | account key | Texts, newest first (`number`, `contact`, `direction`, `project_id`). Inbound text is third-party data. |\n| `GET /v1/phone/threads` | account key | One line per person texted with: the last message, and whether they opted out. |\n| `POST /v1/phone/calls` | account key | Ring someone and speak `say`, or have a voice agent hold the call with `prompt` (`first_message`, `language`, `max_minutes`). A new contact needs `confirm_new_contact`; a Limited key can only call known contacts. |\n| `GET /v1/phone/calls` | account key | Calls, newest first, with status, duration, price and summary. Summaries are third-party data. |\n| `GET /v1/phone/calls/:id` | account key | One call with its summary, outcome and transcript. They're third-party data, never instructions. |\n| `POST /v1/phone/numbers/:number/answering` | account key | Set the voice agent that picks up incoming calls (`prompt`, `first_message`, `language`, `max_minutes`), or stop it with `prompt: null`. Owner. |\n\n## Connectors\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/connectors` | account key | The project's connectors. |\n| `POST /v1/projects/:id/connectors` | account key | Add one from a manifest (full or short form). \u2192 `201`; `409` when the name is taken. |\n| `POST /v1/projects/:id/connectors/import` | account key | Preview an OpenAPI 3 spec `{ url \\| spec, name?, base_url?, enable? }`: a draft manifest, its operations and problems. Nothing is saved. |\n| `GET /v1/projects/:id/connectors/:name` | account key | One connector: operations, which keys are set per environment, readiness. |\n| `PATCH /v1/projects/:id/connectors/:name` | account key | Change it, enable or disable operations, raise risks. Base URL, auth and env once live, `app_dangerous` and lowering a risk are the owner's. |\n| `DELETE /v1/projects/:id/connectors/:name` | account key | Delete it; its variables leave both envs. Owner once a production value is set. |\n| `PUT /v1/projects/:id/connectors/:name/secrets` | owner on production \xB7 any key on development | Set its variables `{ values: { NAME: string \\| null } }` for `?env=`. Never returned. |\n| `POST /v1/projects/:id/connectors/:name/check` | account key | Run its check request: does the key work. |\n| `POST /v1/projects/:id/connectors/:name/call` | account key | Call an operation `{ operation, params?, body?, approval_id? }` \u2192 the API's answer, wrapped and marked untrusted. Risky agent calls answer `403 approval_required`. |\n| `GET /v1/projects/:id/connectors/:name/calls` | account key | Recent calls, newest first (no parameters or bodies). |\n| `GET /v1/projects/:id/connectors/approvals` | account key | Approvals, `?status=pending`. |\n| `GET /v1/projects/:id/connectors/approvals/:approvalId` | account key | One approval, with exactly what will be sent. |\n| `POST /v1/projects/:id/connectors/approvals/:approvalId/approve` | full-access key | Approve: the agent calls again with `approval_id` within an hour. |\n| `POST /v1/projects/:id/connectors/approvals/:approvalId/deny` | full-access key | Deny it. |\n\n## Analytics\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/script.js` | public | The tracker: `<script defer src=\".../v1/script.js\" data-key=\"vz_pk_\u2026\">`. |\n| `POST /v1/collect` | site key | One event, `text/plain` JSON \u2264 8 KB; the origin must be a project domain. \u2192 `202`, empty, or `{ replay: true }` on a pageview when the project records by default: the tracker then starts replay. |\n| `GET /v1/projects/:id/analytics` | account key | `?period=24h\\|7d\\|30d` \u2192 `{ totals, timeseries, top_pages, sources, countries, devices, events }`. |\n\n## Replay\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/replays/insights` | account key | What goes wrong for visitors (errors, rage and dead clicks, abandoned forms), with example sessions. Start here. |\n| `GET /v1/projects/:id/replays` | account key | Sessions, most worth watching first. Filters `has_error`, `rage`, `dead`, `incomplete`, `path`, `period`. |\n| `GET /v1/replays/:id` | account key | One session: signals, completeness and a timeline of notable moments. |\n| `GET /v1/replays/:id/events` | account key | The raw recording, streamed and paged. |\n| `POST /v1/replays/:id/share` | account key | A private player link `{ expires_in? }` (1 h default, 24 h max). |\n| `DELETE /v1/replays/:id` | account key | Delete a recording now. \u2192 `204`. |\n| `GET /v1/replays/:id/frames` | account key | Still pictures of what the visitor saw at the session\u2019s moments (`?moments=&limit=&at=<ms>&pointer=`): new pictures are metered page screenshots, ones taken before are free; image links last an hour. |\n| `GET /v1/projects/:id/replays/:replayId/frames` | account key | The same pictures, for a replay of that project. |\n| `GET /v1/replays/:id/player` | signed link | The hosted player page for a share link. |\n\n## Usage and metrics\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/usage` | account key | `?period=24h\\|7d\\|30d\\|month&group_by=\u2026` \u2192 `{ totals, data, limits }`. |\n| `GET /v1/projects/:id/usage` | account key | The same for one project. |\n| `GET /v1/metrics` | account key | Requests, error rate and p50/p95/p99 latency by capability. |\n| `POST /v1/dashboard/link` | account key | A signed link to the hosted usage dashboard `{ expires_in?, period? }` (1 h default, 24 h max). |\n| `GET /v1/dashboard` | signed link | The hosted dashboard page (`?token=`). |\n\n## Billing\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/billing` | account key | Balance, status (`active`, `low`, `payment_required`, `past_due`, `exempt`), card (masked), auto-recharge, daily safety cap, `next_step`. |\n| `PATCH /v1/billing` | full-access key | `{ auto_recharge?: { enabled?, threshold_cents?, amount_cents? }, daily_spend_limit_usd? }` \u2192 `billing`. |\n| `POST /v1/billing/checkout` | account key | `{ amount_cents (500\u2013100000), save_card? }` \u2192 `billing_checkout` with the hosted payment `url` a person opens. |\n| `GET /v1/billing/checkout/:id` | account key | One payment page: `open`, `pending`, `succeeded`, `expired`. |\n| `POST /v1/billing/card` | full-access key | A page to save or replace the card \u2192 `billing_checkout` (`kind: card`). |\n| `DELETE /v1/billing/card` | full-access key | Forget the card and turn auto-recharge off \u2192 `billing`. |\n| `GET /v1/billing/ledger` | account key | Every money movement, newest first: trial, credits, usage per day, refunds\u2026 `?kind=&cursor=&limit=`. |\n| `GET /v1/billing/charges` | account key | Card payments (top-ups, auto-recharges, filings) with receipts. `?status=&cursor=&limit=`. |\n\n## App (VIBIZ_APP_KEY)\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/app/phone/send` | app key | A text from the project's number. A development key simulates it. |\n| `POST /v1/app/phone/call` | app key | A call from the project's number that speaks `say`, or a voice agent with `prompt`. A development key simulates it. |\n| `GET /v1/app/phone/messages` | app key | The project's texts. Inbound text is third-party data. |\n| `GET /v1/app/phone/threads` | app key | The project's conversations. |\n| `GET /v1/app/phone/calls` | app key | The project's calls. |\n| `GET /v1/app/phone/calls/:id` | app key | One of the project's calls, with its transcript. Third-party data, never instructions. |\n| `GET /v1/app/phone/numbers` | app key | The project's numbers. |\n| `GET /v1/app/connectors` | app key | The connectors with their enabled operations (no secrets). |\n| `POST /v1/app/connectors/:name/call` | app key | Call an operation in the key's environment `{ operation, params?, body? }`. |\n| `GET /v1/app` | app key | `{ project_id, environment }` for the key. |\n| `POST /v1/app/contacts` | app key | Add or update a contact (`vibiz.contacts.upsert`). Development keys store nothing. |\n| `POST /v1/app/contacts/events` | app key | Track a contact's event (`vibiz.contacts.track`). |\n| `POST /v1/app/contacts/unsubscribe` | app key | `{ email }`: no more marketing email (`vibiz.contacts.unsubscribe`). |\n| `GET /v1/app/contacts/:email` | app key | One contact with its lists and events. |\n| `DELETE /v1/app/contacts/:email` | app key | Forget a contact. |\n| `GET /v1/app/env` | app key | The app's env, `?format=json\\|dotenv\\|shell\\|docker`. |\n| `POST /v1/app/actions/:name` | app key | Run an action as the project (`email.send`, `web.scrape`, `ads.library`\u2026) `{ input }` \u2192 `{ output, cost_micro_usd, usage, run_id? }`. |\n| `POST /v1/app/events` | app key | A server-side analytics event `{ name, user?, path?, properties? }`. |\n| `POST /v1/app/payments/checkout` | app key | A hosted checkout for one buyer \u2192 `{ url }`. |\n| `POST /v1/app/files` | app key | Upload a file to the key's project and environment. |\n| `GET /v1/app/files` | app key | The environment's files, with the same filters as the project route. |\n| `GET /v1/app/files/latest` | app key | The newest matching file. |\n| `GET /v1/app/files/:fileId` | app key | One file. |\n| `DELETE /v1/app/files/:fileId` | app key | Delete a file. |\n| `GET /v1/app/payments/products` | app key | The catalog. |\n| `GET /v1/app/payments/payments` | app key | Payments, `?user=&cursor=&limit=`. |\n| `GET /v1/app/payments/payments/:paymentId` | app key | One payment. |\n| `GET /v1/app/payments/subscriptions` | app key | A user's subscriptions, web checkout and App Store / Google Play alike (each with `source`), `?user=&status=active,trialing&source=web,app_store,play_store`. |\n| `GET /v1/app/payments/entitlements` | app key | What a user has now, `?user=` \u2192 `{ keys, data: [{ key, source, price_id, lookup_key, store_product_id, expires_at }] }`: one answer across web checkout and the app stores (store purchases read live from the owner's account, cached a minute). |\n| `POST /v1/app/payments/subscriptions/:subId/cancel` | app key | Cancel a subscription for a user. |\n| `POST /v1/app/payments/portal` | app key | A billing portal link `{ user, return_url }` \u2192 `{ url }`. |\n\n## Platform\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/status` | public | What is up right now: `status` (`ok`, `degraded`, `down`, `unknown` when the checks have stopped), `checked_at`, `components`. Never why. |\n| `GET /v1/public/live` | public | The public live page: for each project whose owner turned `public_live` on, its name, address, visits (7 days, by country), deploys and sales counted (30 days), and a feed of the latest 50 visits, deploys and sales, to the minute. No ids, emails, amounts or paths. Cached a minute; any origin may read it. |\n| `GET /v1/capabilities` | account key | Resource types, action names and services (`company`, `payments`, `social`) this deployment offers. |\n| `GET /v1/operations/:id` | account key | One queued unit of work: `{ kind, status: queued\\|running\\|succeeded\\|failed, attempts, error }`. |"
|
|
742
|
+
"body": "Base URL: `https://app.vibiz.app/v1`. Authenticate with `Authorization: Bearer <key>`. Request and response bodies are JSON unless a route says otherwise; every response has an `X-Request-Id`.\n\n```bash\ncurl https://app.vibiz.app/v1/projects -H \"Authorization: Bearer $VIBIZ_API_KEY\"\n```\n\n- **Keys**: an account key (`vz_sk_\u2026`, agent or owner access), the app key (`vz_app_\u2026`) on `/v1/app/*` and `/v1/ai/*`, or a project AI key (`vz_ai_\u2026`) on `/v1/ai/*`. See [Keys and environments](/docs/keys).\n- **Environments**: project routes for payments, company, sign-in and the database take `?env=production|development`; the default is production for full-access keys and development for Limited keys.\n- **Idempotency**: any `POST` takes `Idempotency-Key` (24 hours).\n- **Errors**: `{ \"error\": { \"code\", \"message\", \"details\"? } }`. See [Errors](/docs/errors).\n- **Lists**: `{ \"object\": \"list\", \"data\": [...] }`; payments lists add `has_more` and `next_cursor`.\n- **Async work**: creating a project, adding a resource and deploying answer `202` with the queued operations; poll the object.\n\nAuth below: *account key* is any account key; *full-access key* refuses Limited keys with `403 owner_only`; *owner on production* means a Limited key may do it in development only.\n\n## Projects\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/health` | account key | Mission Control: every active project with its health, worst first: `status` (`fail`, `warn`, `ok`, `unknown`), `checked_at`, `counts`, `top` (the 3 worst problems, each with `detail`, `fix`, `link`, `since`), `metrics` (`visitors_7d`, `pageviews_24h`, `sales_30d`, `errors_24h`) and `console_url`; with `totals`. `?status=fail` (or `fail,warn`), `?q=`. Without credentials it is the liveness probe: `{ ok: true }`. |\n| `POST /v1/health/run` | account key | Check every project again now, in the background \u2192 `202` `{ queued }`. Twice per 10 minutes; checks also run hourly. |\n| `GET /v1/projects/:id/health` | account key | One project's health checks, worst first (site up, last deploy, resources, errors, traffic, sitemap & pages, payments, limits, domain), each with `detail`, `fix`, `link` and `since`. Checked on this read if it never was. |\n| `POST /v1/projects/:id/health/run` | account key | Check one project now \u2192 its checks. 5 a minute per project. |\n| `GET /v1/mission-control` | account key | Mission Control's board in one call: every active project as a row of `steps` (domain, deploy, pages, traffic, experience, payments, sales, limits; each with `status`, `set_up`, `value`, `line`, `link`; the pages step's `value` is how many pages the sitemap lists), its `metrics` (30 days of `pageviews_30d`/`visitors_30d`, `visitors_7d` and `visitors_prev_7d` with `visitors_change_pct`, sales and revenue 30 days and today, `errors_24h`, `sitemap_pages`, `indexed_pages` and `search_clicks_7d` (Google Search Console; null until the site is verified there), `ai_spend_today_usd_micro`, `top_sources_7d`, `top_pages_7d`, `last_deploy`, `latest_problem_replay`), worst first; plus `insights` (`today`, `movers`, `new_problems`, `top_sources_7d`) and the `layout`. Figures kept a minute (`metrics_at`), health fresh. |\n| `GET /v1/projects/:id/search` | account key | Where the project's pages go to search engines and what they say: `indexnow` with the `host` sent (its own domain, or the free address when turned on), `pages_sent`, `last_sent_at`, `last_sent_count`, `key_url` and a `note` when the last run sent nothing; `google` (the account's own Search Console) with `connected`, `property`, `verify_method`, `verified_at`, `sitemap_submitted_at`, `last_sync_at`, `note` (what failed, why, how to fix), `totals` (`pages_known`, `indexed`, `not_indexed`, `not_inspected`), `clicks_28d`, `impressions_28d`, `position_28d`, `daily`, `top_queries`, `top_pages`; `bing` with `connected`, `site_added_at`, `verified_at`, `clicks_28d`, `impressions_28d`, `note`. |\n| `GET /v1/projects/:id/search/pages` | account key | The sitemap's pages as Google sees them (URL Inspection, up to 200 a day): `state` `indexed`, `not_indexed` or `all` (default), `limit` (\u2264 200), `offset`. Each has `indexed`, `verdict`, `coverage_state` (Google's words), `last_crawl_time`, canonicals and `google_inspect_url`, where the owner clicks Request indexing. |\n| `POST /v1/projects/:id/search/sync` | account key | Set the site up in Google and Bing and read them now instead of waiting for the daily sync \u2192 the project search. 3 per 10 minutes per project. |\n| `GET /v1/search/connections` | account key | The account's own search engine accounts: Google Search Console (`account_email`, `sites` of `site_limit` 1,000, `status`, `error`) and Bing Webmaster. `google_available`: whether this Stack can connect Google. Tokens and keys are never returned. |\n| `POST /v1/search/google/connect` | full-access key | Connect a Google account's Search Console \u2192 `{ url }`, Google's consent page; open it in a browser. Several Google accounts can be connected (Google allows 1,000 sites each). `not_configured` when this Stack has no Google client. |\n| `POST /v1/search/google/key` | account key | Owner: add a Google service-account key (`key`: the JSON file as text or an object) so every project goes into Search Console without anyone signing in; `owner_email` is added as an owner of every site. Checked with Google first (an API that's off is named with its link); stored sealed, never shown. \u2192 the connections. |\n| `POST /v1/search/bing` | full-access key | `{ api_key }`: the Bing Webmaster API key (Bing Webmaster Tools \u25B8 Settings \u25B8 API access), checked with Bing, then used for every project; replaces the previous one. |\n| `DELETE /v1/search/connections/:id` | full-access key | Disconnect a Google account (its access is revoked at Google) or the Bing key. Projects on that Google account move to another connected one on the next sync. |\n| `PATCH /v1/projects/:id/search` | account key | `{ submit_free_address }`: also send the free vibiz.app address while there is no own domain (off by default). |\n| `POST /v1/projects/:id/search/submit` | account key | Send the pages that are new or changed in the sitemap to IndexNow now; `run` has `sent` and `host`, or `note` saying why nothing went. |\n| `GET /v1/mission-control/layout` | account key | The account's pinned rows and row order on the board: `rows` of `{ project_id, pinned, position }`. |\n| `PUT /v1/mission-control/layout` | account key | Pin or order rows: `{ rows: [{ project_id, pinned, position }], replace? }`; `replace: true` drops every row not listed (Tidy up). Each project once; another account's project is `404`. |\n| `POST /v1/projects` | account key | Create a project `{ name, slug?, resources? }`. Default resources: hosting, database, auth, analytics. \u2192 `202 { project, operations }`. |\n| `GET /v1/projects` | account key | List projects, each with `url`, `primary_url` and `custom_domains`. |\n| `GET /v1/projects/metrics` | account key | Every project's revenue (30 days, net of refunds, `usd_cents` plus `by_currency` as charged) and visitors (7 days) in one call, with the account's `totals`. `?env=production\\|development` (default production). \u2192 `list` of `project_metrics`. |\n| `GET /v1/projects/:id` | account key | One project with its resources, `url` (the vibiz.app address), `primary_url` (a live own domain, else `url`) `custom_domains` (`{ domain, hosting, live }`, live first) and `public_live`. |\n| `PATCH /v1/projects/:id` | full-access key | Change a project's settings: `{ public_live: true\\|false }` shows it on the public live page or takes it off at once. \u2192 the project. |\n| `GET /v1/projects/:id/icon` | account key | The live site's favicon as a data URI (`icon`, null without one), fetched by thelastapi. |\n| `DELETE /v1/projects/:id` | account key | Site offline now; data destroyed after 7 days. `409 payments_held` while it holds live money. \u2192 `202` with `delete_after`. |\n| `POST /v1/projects/:id/restore` | account key | Undo a delete within the 7 days; what was live is rebuilt. \u2192 `202`. |\n| `POST /v1/projects/:id/resources` | account key | Add a resource `{ type }` (`hosting`, `database`, `auth`, `email`, `analytics`, `replay`, `ai`); dependencies are added. \u2192 `202`. |\n| `PATCH /v1/projects/:id/resources/:type` | account key | Change a resource's settings `{ config }` (only `replay` has settings). |\n| `GET /v1/projects/:id/env` | full-access key | The production env values. `?names=1` lists only the names, for any key. |\n| `GET /v1/projects/:id/env/vars` | account key | The app's own variables: `data[]` with `name`, `environment` and `updated_at`, never a value. |\n| `PUT /v1/projects/:id/env/:name` | owner on production \xB7 any key on development | Set one of the app's own variables `{ value, environment? }` (`production` by default): write-only, sealed, added to the env the app loads and to connected hosts. `NAME`: capitals, digits and `_`; a name thelastapi sets answers `409`. |\n| `DELETE /v1/projects/:id/env/:name` | owner on production \xB7 any key on development | Remove one of the app's own variables (`?environment=development` for the development one). |\n| `POST /v1/projects/:id/secret-link` | account key | The console link where a person types one secret `{ name, environment?, kind? }` (`env`, `connector`, `ai`, `host`): what an agent hands over instead of asking for the value in a chat. \u2192 `{ console_url }`. |\n| `GET /v1/projects/:id/domains` | account key | The free `address` and the owner's own domains: `data[]` with `status` (`pending_dns`, `verifying`, `active`, `error`, `external`), `https` and the `records_to_set` (`type`, `name`, `value`); `domains` lists the names. |\n| `POST /v1/projects/:id/domains` | account key | Connect a domain `{ domain, hosting? }` (`vibiz`: served here with HTTPS, the default with hosting; `elsewhere`: only trusted). At most 10; `409 domain_taken` if another project has it. \u2192 `201` with `domain`. |\n| `POST /v1/projects/:id/domains/:domain/verify` | account key | Check DNS and ownership again now. \u2192 the domain. |\n| `DELETE /v1/projects/:id/domains/:domain` | full-access key | Disconnect a domain (and its `www` redirect). |\n| `POST /v1/projects/:id/domains/buy` | full-access key | Buy a domain from credits for this project `{ domain, years?, expected_price_cents, confirm_premium?, contact?, save_contact?, additional? }`: registered to the saved owner details, served here at once. \u2192 `202` the owned domain. `402` short of credits, `409 price_changed` with a new quote; agents get `owner_only` with the console link. |\n| `POST /v1/domains/buy` | full-access key | Buy a domain for the account `{ domain, project_id?, years?, expected_price_cents, \u2026 }` (as the project route): on `project_id` once registered, or none to use later. \u2192 `202` the owned domain. |\n| `POST /v1/domains/:domain/use` | account key | Use a bought domain, or a name under it, on any of the account's projects `{ project_id (id or slug), name?, hosting?, points_to? }`: no DNS to set, trusted for sign-in at once. `409 in_use` (with `used_on` and the move) when another project has it. \u2192 `domain_use`. |\n| `POST /v1/domains/:domain/move` | full-access key | Move a name of a bought domain to another project `{ to_project_id, name?, from_project_id?, hosting?, points_to? }`: the old project lets go of it (and its `www`). \u2192 `domain_use` with `moved_from`. |\n| `POST /v1/domains/:domain/point` | account key | A bought name used by an app on another host: point it there `{ name?, points_to, project_id? }` (`null` clears it); we write the record in its DNS. \u2192 `domain_use`. |\n| `GET /v1/domains/search` | account key | Domains for a name `?q=` across endings, with `price_cents` and `renewal_price_cents` (USD) and a `buy_url`. |\n| `GET /v1/domains/quote` | account key | One domain `?domain=&years=&project_id=`: the price, the balance after, the owner details it still needs (`fields_needed`) and `buy_url` for the owner. |\n| `GET /v1/domains` | account key | Domains the account bought: `status`, `expires_at`, `auto_renew`, `renewal_price_cents`, `registered_to`, `used_on` (every project and name using it), `contact_verification` (`status`, `verify_by`, `can_confirm`), `last_order`. |\n| `GET /v1/domains/:domain` | account key | One bought domain. |\n| `PATCH /v1/domains/:domain` | full-access key | Turn auto-renew (from credits, ~30 days before expiry) on or off `{ auto_renew }`. |\n| `POST /v1/domains/:domain/renew` | full-access key | Renew now from credits `{ years?, expected_price_cents }` \u2192 `202`. |\n| `GET /v1/domains/:domain/records` | account key | A bought domain's DNS records: `id`, `type`, `name` (relative, `''` the domain itself), `value`, `ttl`, `priority` (MX), and `managed` / `managed_by` (`hosting`, `email`, `default`) for the ones Vibiz keeps. |\n| `POST /v1/domains/:domain/records` | full-access key | Add a record `{ type: A\\|AAAA\\|CNAME\\|MX\\|TXT\\|CAA, name, value, ttl?, priority? }` \u2192 `201` the record (`200` with `created: false` when the same one is already there). |\n| `DELETE /v1/domains/:domain/records/:id` | full-access key | Remove a record. A `managed` one answers `409 managed_record` with what to run instead, unless `?force=1`. |\n| `POST /v1/domains/:domain/contact-verification/confirm` | full-access key | Confirm the owner's contact details for a new domain (ICANN asks within 15 days) when `contact_verification.can_confirm`. \u2192 the owned domain. |\n| `POST /v1/domains/:domain/contact-verification/check` | account key | Check now whether the owner's contact details are confirmed. \u2192 the owned domain. |\n| `POST /v1/domains/:domain/auth-code` | full-access key | The transfer code another registrar asks for. |\n| `GET /v1/domains/owner` | full-access key | The domain owner details (the registrant every new domain is registered to). |\n| `PUT /v1/domains/owner` | full-access key | Save the domain owner details `{ contact }`; they apply to domains bought from then on. |\n\n## Development environment\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/dev` | account key | `{ status: none\\|provisioning\\|ready\\|failed, resources }`. |\n| `POST /v1/projects/:id/dev` | account key | Create the development copies (idempotent). \u2192 `202`. |\n| `GET /v1/projects/:id/dev/env` | account key | The development env values; `409` until ready. |\n| `DELETE /v1/projects/:id/dev` | account key | Throw the development copies away. \u2192 `202`. |\n\n## Keys and hosts\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/waitlist` | public | Join the waitlist for a new account: `{ email, source? }` \u2192 `200 { object: \"waitlist_signup\", listed: true }`, the same answer whether or not the email was already listed. 20 per address per hour. |\n| `POST /v1/cli/login` | public | Start a browser login (`vibiz login`): `{ hostname?, os?, cli_version? }` \u2192 `201 { device_code, user_code, verification_uri, verification_uri_complete, expires_in, interval }`. The person opens the link and clicks Authorize. 10 per address per 10 minutes. |\n| `POST /v1/cli/login/token` | public | Poll a browser login `{ device_code }` every `interval` seconds: `400 { error }` with `authorization_pending`, `slow_down`, `expired_token`, `access_denied` or `invalid_grant` (`authorization_pending` with `reason: signup_closed` and `waitlist_url` when the person who opened the link is not invited: stop and pass on `error_description`); once approved, `200 { api_key, key, account, api_url }`, exactly once. The key is a new Limited key named `cli \xB7 <hostname>`. |\n| `GET /v1/whoami` | account key | The account and key this request acts as: `{ account, key: { id, name, prefix, kind, access }, role }`. |\n| `POST /v1/cli/logout` | account key | The calling key revokes itself (`vibiz logout` for a key a browser login made). |\n| `GET /v1/api-keys` | account key | Named keys, no secrets, with `access`. |\n| `POST /v1/api-keys` | full-access key | Create a key `{ name, access?: owner\\|agent }` (default owner, Full access; agent is Limited). The secret is returned once. \u2192 `201`. |\n| `PATCH /v1/api-keys/:id` | full-access key | Change a key's access `{ access: owner\\|agent }` (Full access or Limited). A Limited key can't change any key, and a key can't change its own. |\n| `DELETE /v1/api-keys/:id` | full-access key | Revoke a key (a key can't revoke itself). |\n| `GET /v1/projects/:id/app-keys` | account key | App key prefixes and last use, per environment, each with the `console_url` that opens it ready to copy. |\n| `GET /v1/projects/:id/app-keys/:environment` | owner on production \xB7 any key on development | The app key itself, to paste into a host thelastapi can't connect to. A Limited key gets `owner_only` with the `console_url` to hand over. |\n| `POST /v1/projects/:id/app-keys/rotate` | owner on production \xB7 any key on development | Rotate an app key `{ environment, grace_seconds }`; the new key is pushed everywhere, never shown. |\n| `GET /v1/hosts` | account key | The hosts thelastapi can connect to and what each asks for. |\n| `GET /v1/projects/:id/hosts` | account key | Connected hosts: status and the variable names written. |\n| `POST /v1/projects/:id/hosts` | full-access key | Connect a host `{ kind, token, project?, team_id?, environments? }`; the token is checked first. \u2192 `201`. |\n| `POST /v1/projects/:id/hosts/sync` | account key | Push the env to every connected host now. \u2192 `202`. |\n| `DELETE /v1/projects/:id/hosts/:target` | full-access key | Disconnect; `?keep_values=1` leaves the values in place. |\n\n## Hosting\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/files/missing` | account key | Which of `{ shas }` (SHA-1, up to 10,000) still need uploading. |\n| `PUT /v1/files/:sha` | account key | Upload one file (raw bytes, up to 50 MB); must match its SHA-1. \u2192 `204`. |\n| `POST /v1/projects/:id/deployments` | account key | Build `{ files: [{ path, sha, size }], target? }` (`production` by default, or `preview`). \u2192 `202 { deployment, operation }`. |\n| `GET /v1/projects/:id/deployments` | account key | The latest 50 deployments. |\n| `GET /v1/deployments/:id` | account key | `status`: `queued \u2192 building \u2192 ready` or `failed`. |\n| `GET /v1/deployments/:id/files` | account key | The deployment's code as deployed: `data[]` with every file's `path`, `sha` and `size`. |\n| `GET /v1/deployments/:id/files/*` | account key | One file's bytes by its path (`/files/src/app.js`), with `x-vibiz-sha`. `404` for a path the deployment doesn't have. |\n| `GET /v1/projects/:id/versions` | account key | Version history, newest first: `data[]` with `message`, `summary`, `who`, `created_at`, `target`, `status`, `live` and `files` added, updated and deleted against the version before. `?limit=`, `?cursor=`. |\n| `GET /v1/projects/:id/versions/diff` | account key | What changed between two versions: `?to=` (default the live one) against `?from=` (default the one before). `files[]` with a unified `diff` for text and sizes for binary files; `unavailable[]` names files no longer stored, with why. |\n| `POST /v1/projects/:id/versions/:version/restore` | account key | Put a version live again: `:version` is an id or `previous`. Instant for a production version (`200`), rebuilt for a preview or a build the host no longer keeps (`202`). The database is not rolled back: the answer has a `warning` saying so. |\n| `POST /v1/deployments/:id/promote` | account key | Make it live: a production deployment switches instantly (`200`, how rollback works); a preview is rebuilt as production (`202`). |\n\n## Database and users\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/database` | owner on production \xB7 any key on development | The app database's schemas and tables. `?env=`. |\n| `GET /v1/projects/:id/database/tables/:schema/:table` | owner on production \xB7 any key on development | One table's rows, read-only. `limit` (\u2264 200), `offset`. |\n| `POST /v1/projects/:id/database/query` | owner on production \xB7 any key on development | One read-only statement `{ sql, env? }` (SELECT, WITH, TABLE, VALUES, EXPLAIN, SHOW). |\n| `GET /v1/projects/:id/users` | owner on production \xB7 any key on development | The app's signed-up users. `limit` (\u2264 100), `offset`, `search`. |\n| `POST /v1/projects/:id/users/:user/sign-out` | full-access key | End one user's sessions. |\n\n## Sign-in\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/auth/settings` | owner on production \xB7 any key on development | Sign-in settings for `?env=`: email and password, magic link, providers with callback URLs, localhost, allowed domains, sender. |\n| `PATCH /v1/projects/:id/auth/settings` | owner on production \xB7 any key on development | Change sign-in settings (partial). |\n| `PUT /v1/projects/:id/auth/providers/:provider` | owner on production \xB7 any key on development | `google`, `github`, `vercel`: `{ credentials: \"shared\" }` (Google only) or `{ credentials: \"own\", client_id, client_secret }`. |\n| `DELETE /v1/projects/:id/auth/providers/:provider` | owner on production \xB7 any key on development | Turn a provider off. |\n| `POST /v1/projects/:id/auth/test-email` | full-access key | A test message `{ to }` through the SMTP sender that is set. |\n\n## Email\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/email` | account key | The project's mail domain, status, today's sends and recent activity. |\n| `GET /v1/forwarding` | account key | Email forwarding on every domain of the account: `data[]` as `GET /v1/domains/:domain/forwarding`. |\n| `GET /v1/domains/:domain/forwarding` | account key | Email forwarding for a domain: `status` (`off`, `needs_dns`, `verifying`, `active`, `failed`), `managed_dns`, the `records` it needs, `mx` (whose mail servers it points at, with a warning when they are another provider's), `rules[]` (`address`, `to[]` with each inbox's `status`: `pending` until it confirms, `confirmed`, `disabled`), `forwarded_today`, `daily_cap`, `next_step`. |\n| `PUT /v1/domains/:domain/forwarding` | full-access key | Set every rule `{ rules: [{ address: \"hello\" \\| \"*\", to: [\"me@example.com\"] }], replace_mx? }` (up to 5 inboxes each; `*` is any other address). Domains bought through thelastapi get their records set; `replace_mx: true` confirms taking the domain's mail from the provider it uses today. New inboxes get a confirmation email. Agents get `owner_only` with a `console_url` that has their proposal filled in. |\n| `DELETE /v1/domains/:domain/forwarding` | full-access key | Turn email forwarding off for the domain and remove the records thelastapi set. |\n| `POST /v1/domains/:domain/forwarding/verify-dns` | account key | Check the domain's records again now. \u2192 the forwarding. |\n| `GET /v1/domains/:domain/forwarding/log` | account key | Recent messages to the domain's forwarding addresses (`?limit=`, \u2264 200; kept 30 days): `at`, `from`, `to`, `destination`, `subject`, `status` (`sent`, `unconfirmed`, `spam`, `virus`, `dmarc`, `loop`, `no_rule`, `daily_cap`, `sender_limit`, `too_large`, `disabled`, `failed`), `detail`. Never a body. |\n| `GET /v1/inbox/mailboxes` | account key | The account's mailboxes at its own domains (`hello@yourdomain.com`, `*@\u2026` for every other address): `data[]` (`address`, `agent_access`, `unread`, `sent_today`, `daily_send_cap`) and `domains[]` with each DNS record's `status`. |\n| `POST /v1/inbox/mailboxes` | full-access key | Add a mailbox `{ address, display_name?, signature?, project_id?, agent_access?, daily_send_cap?, replace_mx? }`: the domain is set up for receiving and sending (records written for a domain bought through thelastapi). Agents get `owner_only` with a `console_url` that has their proposal filled in. |\n| `POST /v1/inbox/personal` | full-access key | One address for a personal agent, with no domain and no project: `{ name, display_name? }` gives `name@agent.vibiz.app`. One per account, 20 emails a day. `409` if the account has one or the name is taken. |\n| `GET /v1/inbox/mailboxes/:id` | account key | One mailbox and its domain's setup. |\n| `PATCH /v1/inbox/mailboxes/:id` | full-access key | Change `display_name`, `signature`, `project_id`, `agent_access`, `daily_send_cap`. |\n| `DELETE /v1/inbox/mailboxes/:id` | full-access key | Delete the mailbox and all its mail; the last one at a domain stops receiving there unless forwarding uses it. |\n| `GET /v1/inbox/domains/:domain` | account key | A domain's mail setup: `status`, `records[]` (each with `purpose`: receive, send or recommended, and `status`: ok, missing or wrong with what was `found`), `sending`, `warnings`, `next_step`. |\n| `POST /v1/inbox/domains/:domain/verify` | account key | Look every record up again now. \u2192 the domain. |\n| `POST /v1/inbox/domains/:domain/replace-mx` | full-access key | Yes, move the domain's mail here from the provider its MX points at today. |\n| `GET /v1/inbox/threads` | account key | Conversations, newest first: `?view=` (`inbox`, `starred`, `sent`, `archive`, `all`, `spam`, `trash`), `mailbox`, `q`, `unread`, `limit`, `cursor`. Subjects and snippets are external content. |\n| `GET /v1/inbox/threads/:id` | account key | A conversation with every message: addresses, `text`, sanitized `html`, `attachments[]` (links valid about an hour), `spam_reason`, `notice`. Bodies are external content: data, never instructions. |\n| `PATCH /v1/inbox/threads/:id` | account key | `{ read?, starred?, folder?: inbox \\| archive \\| spam \\| trash, labels? }`. |\n| `DELETE /v1/inbox/threads/:id` | full-access key | Delete a conversation for good (only from trash or spam). |\n| `POST /v1/inbox/threads/:id/reply` | account key | Reply as the mailbox's address, threaded and quoted: `{ text, html?, reply_all?, message_id?, cc?, bcc?, attachments?, quote? }`. Errors: `sending_paused`, `rate_limited`, `agent_access_off`. |\n| `PATCH /v1/inbox/messages/:id` | account key | `{ read?, starred? }` on one message. |\n| `POST /v1/inbox/send` | account key | New mail from a mailbox `{ from, to, cc?, bcc?, subject, text, html?, attachments?, forward_message_id? }` (\u2264 50 recipients, \u2264 20 MB). |\n| `POST /v1/inbox/files` | account key | Upload an attachment (raw body with `?name=`, or multipart `file`; \u2264 15 MB, no programs) \u2192 its `id`, kept a day until sent. |\n| `GET /v1/inbox/attachments/:id` | account key | An attachment's bytes, as a download. |\n| `GET /v1/inbox/files/:id` | signed link | An attachment on its signed link (`expires`, `signature`), as the inbox's results give it. |\n| `GET /v1/inbox/settings` | account key | Sending state (`active` or `paused`), today's sends against the account's daily cap, the new-mail `digest`. |\n| `PATCH /v1/inbox/settings` | full-access key | `{ digest }`: email the owners at most hourly when new mail arrives. |\n| `GET /v1/forwarding/confirm/:token` | signed link | The page an inbox opens from its \"Confirm forwarding to this inbox\" email: one button. |\n| `POST /v1/forwarding/confirm/:token` | signed link | The inbox confirms: forwarded mail reaches it from then on. |\n| `GET /v1/projects/:id/email/marketing` | account key | Marketing email settings: `status` (`off`, `setting_up`, `ready`, `paused`, `blocked`), `sender` (`news.<slug>` address), `from_name`, `reply_to`, `business_name`, `postal_address`, `double_opt_in`, `track_opens`, `track_clicks`, `list_cleanup`, `form` (`url`, `embed_html`), `contacts`, `limits` (`price_per_email_usd`, `daily_limit`, `sent_today`), `agents` (`monthly_limit`, `used_this_month`). |\n| `PATCH /v1/projects/:id/email/marketing` | account key | Change settings. `postal_address`, `agent_monthly_limit` and turning `double_opt_in` off are the owner's. |\n| `POST /v1/projects/:id/email/marketing/setup` | account key | Set up sending (adds the email resource if needed): `202`, `status: setting_up` until the address verifies, then `ready`. |\n| `GET /v1/projects/:id/email/lists` | account key | Lists with their `subscribed` counts. |\n| `POST /v1/projects/:id/email/lists` | account key | `{ name, description?, public? }` \u2192 the list. `public` lists show on the preference page. |\n| `PATCH /v1/projects/:id/email/lists/:list` | account key | Rename or describe a list (id or name). |\n| `DELETE /v1/projects/:id/email/lists/:list` | account key | Delete a list (its contacts stay). |\n| `GET /v1/projects/:id/email/contacts/export` | account key | Contacts as CSV (`?status=`, `?list=`), with consent and properties. |\n| `GET /v1/projects/:id/email/contacts/imports` | account key | Past imports with their reports. |\n| `POST /v1/projects/:id/email/contacts/import` | account key | Import a CSV `{ csv, dry_run?, consent, lists?, fix_typos?, include_role?, update_existing? }` \u2192 a report: `new_contacts`, `updated_contacts`, `skipped` by reason, `samples`, `typo_suggestions`. `consent: true` is required to import. |\n| `GET /v1/projects/:id/email/contacts` | account key | Contacts, newest first: `?q=`, `?status=`, `?list=`, `?segment=`, `?cursor=`, `?limit=` (\u2264 200); `total`. |\n| `POST /v1/projects/:id/email/contacts` | account key | Add or update one by email `{ email, first_name?, last_name?, properties?, lists?, subscribed?, double_opt_in?, consent? }`. Never re-subscribes someone who left: they get a confirmation email (`pending`). |\n| `GET /v1/projects/:id/email/contacts/:contact` | account key | One contact (id or email) with its lists and last 20 events. |\n| `PATCH /v1/projects/:id/email/contacts/:contact` | account key | `{ first_name?, last_name?, properties?, status?: subscribed \\| unsubscribed, add_lists?, remove_lists? }`. Subscribing again by hand is the owner's. |\n| `DELETE /v1/projects/:id/email/contacts/:contact` | account key | Forget a contact. An address that unsubscribed, bounced or complained stays suppressed. |\n| `POST /v1/projects/:id/email/events` | account key | `{ email, event, properties? }`: something a contact did. Starts event automations and ends runs whose exit event it is. |\n| `GET /v1/projects/:id/email/segments` | account key | Saved segments with their `contacts` counts. |\n| `POST /v1/projects/:id/email/segments/preview` | account key | `{ filter }` \u2192 `contacts` and a sample, without saving. |\n| `POST /v1/projects/:id/email/segments` | account key | `{ name, filter: { match: all \\| any, conditions[] } }`: properties, fields, lists, events, engagement. |\n| `PATCH /v1/projects/:id/email/segments/:segment` | account key | Rename it or change its filter. |\n| `DELETE /v1/projects/:id/email/segments/:segment` | account key | Delete a segment. |\n| `POST /v1/projects/:id/email/render` | account key | Render a draft `{ subject, preview_text?, format, body, contact_id? }` as a contact gets it: `html`, `text`, `size_bytes`, `merge_tags`. |\n| `GET /v1/projects/:id/email/broadcasts` | account key | Broadcasts, newest first (`?status=`), with their stats. |\n| `POST /v1/projects/:id/email/broadcasts` | account key | A draft `{ name?, subject, preview_text?, from_local?, from_name?, reply_to?, format: markdown \\| html, body, audience: { list_id?, segment_id? } }`. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast` | account key | One broadcast: `status`, `waiting`, `recipients`, `charged_cents`, `stats` (sent, delivered, opened, clicked, bounced, complained, unsubscribed, rates, `by_mailbox`). |\n| `PATCH /v1/projects/:id/email/broadcasts/:broadcast` | account key | Edit a draft, a scheduled or a waiting-for-approval broadcast. |\n| `DELETE /v1/projects/:id/email/broadcasts/:broadcast` | account key | Delete a draft or canceled broadcast. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast/review` | account key | The checklist before sending: `ready`, `checks[]` (`ok`, `warning`, `error`), `audience`, `cost` (`total_cents`, `balance_cents`, `enough_credits`), `sending`, `preview`, `console_url`. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/test` | account key | Send a free `[Test]` copy `{ to? }` (agents: to the owners only; 20 a day). |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/send` | account key | Send now or `{ scheduled_at }`. An agent sends only within the owner's monthly allowance; otherwise `403 owner_only` with the review link. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/cancel` | account key | Stop it; nothing more goes out and the held credits are released. |\n| `POST /v1/projects/:id/email/broadcasts/:broadcast/resume` | full-access key | Go on after a pause. |\n| `GET /v1/projects/:id/email/broadcasts/:broadcast/recipients` | account key | Who got it: `?status=` (`sent`, `delivered`, `opened`, `clicked`, `bounced`, `complained`, `unsubscribed`, `failed`), `?mailbox=`, `?cursor=`. |\n| `GET /v1/projects/:id/email/automations` | account key | Automations with their run counts. |\n| `POST /v1/projects/:id/email/automations` | account key | `{ name, trigger, steps[], exit_event? }`: triggers `contact_added`, `event`, `date`; steps `wait`, `email`, `condition` (`yes[]`, `no[]`), `exit`. |\n| `GET /v1/projects/:id/email/automations/:automation` | account key | One automation with `enrollments` counts and emails sent, opened, clicked. |\n| `PATCH /v1/projects/:id/email/automations/:automation` | account key | Edit. While active only email wording changes; pause it to change the trigger, waits or branches. |\n| `DELETE /v1/projects/:id/email/automations/:automation` | account key | Delete it (archived if it sent email). |\n| `POST /v1/projects/:id/email/automations/:automation/activate` | account key | Turn it on. An agent needs the owner's monthly allowance; otherwise `403 owner_only` with the console link. |\n| `POST /v1/projects/:id/email/automations/:automation/pause` | account key | Pause it; runs wait where they are. |\n| `GET /v1/projects/:id/email/automations/:automation/enrollments` | account key | Runs: `?status=` (`active`, `completed`, `exited`, `failed`), each with its `step_id`, `next_run_at`, `history`. |\n| `POST /v1/projects/:id/email/automations/:automation/test` | account key | Send one email step as a free test `{ step_id, to? }`. |\n| `GET /v1/email/u/:token` | signed link | The unsubscribe page a contact opens from an email (`?view=preferences`: lists to keep). GET changes nothing. |\n| `POST /v1/email/u/:token` | signed link | One-click unsubscribe (`List-Unsubscribe=One-Click`, RFC 8058), or the page's form: unsubscribe, subscribe again, save lists, never from anyone. |\n| `GET /v1/email/confirm/:token` | signed link | The double opt-in page: one button. |\n| `POST /v1/email/confirm/:token` | signed link | The contact confirms: `subscribed`. |\n| `GET /v1/email/k/:token` | signed link | \"Keep sending\" page from the list-cleanup email. |\n| `POST /v1/email/k/:token` | signed link | The contact keeps getting emails. |\n| `GET /v1/email/o/:token` | signed link | Open tracking pixel. |\n| `GET /v1/email/c/:token` | signed link | Click tracking: redirects to the signed destination. |\n| `GET /v1/email/f/:form` | public | The hosted signup form. |\n| `POST /v1/email/f/:form` | public | A signup from the form, a pasted snippet or JSON from any site `{ email, first_name? }`: honeypot, rate limits, double opt-in. |\n| `OPTIONS /v1/email/f/:form` | public | CORS preflight for the signup API. |\n\n## AI\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/ai/chat/completions` | account, project AI or app key | OpenAI chat completions, streaming (SSE) or not. `model` defaults to `vibiz/fast`. |\n| `POST /v1/ai/embeddings` | account, project AI or app key | Embeddings. |\n| `POST /v1/ai/images/generations` | account, project AI or app key | Images: `b64_json` (default) or `url` (24 h). |\n| `POST /v1/ai/audio/speech` | account, project AI or app key | Text to speech; streams `mp3` or `pcm`. |\n| `POST /v1/ai/audio/transcriptions` | account, project AI or app key | Speech to text, multipart `file` (\u2264 25 MB). |\n| `POST /v1/ai/jobs` | account, project AI or app key | Async image or video `{ type, model?, input }`. \u2192 `202`. |\n| `GET /v1/ai/jobs/:id` | account, project AI or app key | A job and, once done, its output. |\n| `POST /v1/ai/jobs/:id/cancel` | account, project AI or app key | Cancel a job. |\n| `GET /v1/ai/models` | public | The thelastapi models, each with the lab model it runs, and the lab models, with prices. `?all=1` every model, `?q=` search. |\n| `GET /v1/ai/health` | public | Per capability `ok`/`degraded`/`down`. |\n| `GET /v1/ai/media/:token` | signed link | Generated media; the token in the link is the credential (24 h). |\n| `GET /v1/projects/:id/ai` | account key | A project's AI key status, budgets, limits and today's spend. |\n| `PATCH /v1/projects/:id/ai` | account key | `{ daily_budget_usd?, end_user_daily_budget_usd?, log_content?, rpm?, tpm?, concurrency? }`. |\n| `POST /v1/projects/:id/ai/keys/rotate` | full-access key | A new project AI key `{ grace_seconds? }` (default 3600), written to the app env. |\n| `POST /v1/projects/:id/ai/keys/revoke` | account key | Every AI key of the project stops now; rotate to get a new one. |\n| `GET /v1/ai-keys` | account key | Your own AI provider keys, the account's: status per provider (never a secret) and calls they served in 30 days. |\n| `GET /v1/ai-keys/:provider` | account key | One key: `has_key`, last 4, last used, last error, and per thelastapi model whether `your_key` or `vibiz` serves (and pays for) it. |\n| `PUT /v1/ai-keys/:provider` | full-access key | Set your own key (`google`): `{ type: \"gemini_api_key\", api_key }` or `{ type: \"vertex\", service_account, project_id?, region? }`, `use_for?`. Checked with a free call first. |\n| `PATCH /v1/ai-keys/:provider` | full-access key | `{ use_for: [capability\u2026] }`: what the key serves; the rest runs on thelastapi. |\n| `DELETE /v1/ai-keys/:provider` | full-access key | Remove the key; calls go back to thelastapi (jobs promised to it fail). |\n| `POST /v1/ai-keys/:provider/test` | account key | Re-check the stored key with the same free call; records the result. |\n| `GET /v1/projects/:id/ai-keys` | account key | Your own AI provider keys, a project's override (else it inherits the account's): status per provider (never a secret) and calls they served in 30 days. |\n| `GET /v1/projects/:id/ai-keys/:provider` | account key | One key: `has_key`, last 4, last used, last error, and per thelastapi model whether `your_key` or `vibiz` serves (and pays for) it. |\n| `PUT /v1/projects/:id/ai-keys/:provider` | full-access key | Set your own key (`google`): `{ type: \"gemini_api_key\", api_key }` or `{ type: \"vertex\", service_account, project_id?, region? }`, `use_for?`. Checked with a free call first. |\n| `PATCH /v1/projects/:id/ai-keys/:provider` | full-access key | `{ use_for: [capability\u2026] }`: what the key serves; the rest runs on thelastapi. |\n| `DELETE /v1/projects/:id/ai-keys/:provider` | full-access key | Remove the key; calls go back to thelastapi (jobs promised to it fail). |\n| `POST /v1/projects/:id/ai-keys/:provider/test` | account key | Re-check the stored key with the same free call; records the result. |\n| `GET /v1/projects/:id/ai/calls` | account key | The project's recent AI calls: model, tokens, cost, outcome (no content). |\n| `POST /v1/actions/ai.chat` | account key | `{ input: { prompt \\| messages, system?, model?, max_tokens?, json? } }` \u2192 `{ output: { text, model, usage }, cost_micro_usd }`. |\n| `POST /v1/projects/:id/actions/ai.chat` | account key | The same, billed to the project. |\n| `POST /v1/actions/image.generate` | account key | `{ input: { prompt, size?, n?, model? } }` \u2192 image links (24 h). |\n| `POST /v1/projects/:id/actions/image.generate` | account key | The same, billed to the project. |\n| `POST /v1/actions/speech.create` | account key | `{ input: { text, voice?, format?, model? } }` \u2192 an audio link. |\n| `POST /v1/projects/:id/actions/speech.create` | account key | The same, billed to the project. |\n| `POST /v1/actions/speech.transcribe` | account key | `{ input: { audio_base64, filename?, language?, model? } }` \u2192 `{ text, language, duration_seconds }`. |\n| `POST /v1/projects/:id/actions/speech.transcribe` | account key | The same, billed to the project. |\n\n## Files\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/files` | account key | The project's files, newest first (`env`, `type`, `source`, `q`, `since`, `until`, `model`, `tag`, `folder`, `limit`, `cursor`), with `total_files` and `total_bytes`. |\n| `POST /v1/projects/:id/files` | account key | Upload a file (raw body with `?name=`, or multipart `file`), up to 50 MB \u2192 the file with its permanent `url`. |\n| `POST /v1/projects/:id/files/import` | account key | Save what a public URL serves `{ url, name?, folder?, private? }`. |\n| `GET /v1/projects/:id/files/latest` | account key | The newest file matching `type`, `source`, `model`, `tag`: what an agent just made. |\n| `GET /v1/projects/:id/files/:fileId` | account key | One file: its link, type, size, dimensions and, for AI media, the model, prompt and cost. |\n| `GET /v1/projects/:id/files/:fileId/content` | account key | The file's bytes, private or not. |\n| `PATCH /v1/projects/:id/files/:fileId` | account key | Rename, move, tag, annotate or make private `{ name?, folder?, tags?, note?, private? }`. |\n| `DELETE /v1/projects/:id/files/:fileId` | account key | Delete a file: its link stops working. |\n\n## Export\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/projects/:id/exports` | owner on production \xB7 any key on development | Pack the project to take it elsewhere `{ include?: [code, database, database_csv, env_guide], env?, deployment_id? }` \u2192 `202` and the export, `queued`. The code is the source of the live deployment (or `deployment_id`) with `VIBIZ-EXPORT.md` and `.env.example`; the database is plain SQL that `psql` restores, CSV optional. A production database is an owner's; one export at a time, 10 a day. |\n| `GET /v1/projects/:id/exports` | account key | The last 20 exports, newest first. |\n| `GET /v1/projects/:id/exports/:exportId` | account key | One export: `status` (`queued`, `running`, `ready`, `failed`, `expired`), `step`, `progress`, and `files` with signed download links until `expires_at` (a day). Agents get no link to production data. |\n| `GET /v1/projects/:id/exports/:exportId/env` | full-access key | The export environment's secret values as a `.env` file, with `confirm=1`. Never cached, never in the zip. |\n\n## Actions\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/actions/:name` | account key | Run an account action `{ input }`: web data (`web.scrape`, `web.search`, `web.crawl`, `web.screenshot`, `web.design`, `ads.library`, `places.search`, `reviews`, `social.profile`, `social.posts`, `ecommerce.product`, `linkedin.company`; SEO data: `seo.serp`, `seo.keywords`, `seo.keyword_ideas`, `seo.domain`, `seo.backlinks`, `seo.audit`, `seo.ai_mentions`) \u2192 `{ output, cost_micro_usd, run_id, console_url }`. `web.design` with `sections: true` captures a page section by section; with `section: <n>` it reads one, free from the saved capture. |\n| `GET /v1/actions` | account key | The web data actions: name, title, one line, slow or not, a hint per field, an example and the input as JSON Schema. |\n| `GET /v1/actions/runs` | account key | Past web data runs, newest first (input, status, cost, no output). `?project=<id>\\|none`, `?action=`, `?since=<iso>`, `?cursor=`, `?limit=` (25, \u2264 100). With `console_url`. |\n| `GET /v1/actions/runs/:id` | account key | One run with its output (cut to 1 MB: `truncated`), error and cost, with `console_url`. |\n| `POST /v1/projects/:id/actions/:name` | account key | Run an action as the project (`email.send`, or any action billed to it) \u2192 `{ project_id, output, cost_micro_usd, usage }`; web data also `run_id`, `console_url`, and a screenshot is saved to the project's Files. |\n\n## Payments\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/payments` | account key | The payments account: where sales go (`account.mode`: `vibiz` or `own`), balance, payouts status, `fees` (with `hold_days` and a $100 example), webhook. |\n| `PATCH /v1/projects/:id/payments` | owner on production \xB7 any key on development | `{ statement_descriptor_suffix?, webhook_url?, webhook_events?, brand? }`. `brand` (`{ name?, logo_url?, icon_url?, background_color?, button_color?, font?, border_style? }`) is the checkout page's look for every checkout, merged field by field (a field set to null goes; `brand: null` clears it). |\n| `POST /v1/projects/:id/payments/webhook-secret` | owner on production \xB7 any key on development | Rotate the webhook secret; shown once and written to the app env as `VIBIZ_WEBHOOK_SECRET`. |\n| `GET /v1/projects/:id/payments/deliveries` | account key | The last 50 webhook deliveries and their status codes. |\n| `GET /v1/projects/:id/payments/products` | account key | The catalog for `?env=`. |\n| `POST /v1/projects/:id/payments/products` | account key | Create `{ name, description?, price?: { unit_amount_cents, currency?, type, interval?, interval_count?, lookup_key? } }` (`currency`: ISO 4217, default `usd`; amounts in its smallest unit). |\n| `GET /v1/projects/:id/payments/products/:productId` | account key | One product with its prices. |\n| `PATCH /v1/projects/:id/payments/products/:productId` | account key | Rename, describe, activate or deactivate. |\n| `DELETE /v1/projects/:id/payments/products/:productId` | owner on production \xB7 any key on development | Archive a product. |\n| `POST /v1/projects/:id/payments/products/:productId/prices` | account key | Add a price `{ unit_amount_cents, currency?, type, interval?, interval_count?, lookup_key? }`. Prices are immutable. |\n| `PATCH /v1/projects/:id/payments/prices/:priceId` | account key | `{ active?, lookup_key? }`. |\n| `POST /v1/projects/:id/payments/checkout` | account key | A hosted checkout `{ price_id \\| lookup_key \\| amount_cents+name(+currency), user?, success_url, cancel_url, brand?, \u2026 }` \u2192 `{ url, expires_at }` (1 h, one buyer). |\n| `GET /v1/projects/:id/payments/payments` | account key | Payments, newest first (`cursor`, `limit`); emails masked for agents on production. |\n| `GET /v1/projects/:id/payments/payments/:paymentId` | account key | One payment. |\n| `POST /v1/projects/:id/payments/payments/:paymentId/refund` | owner on production \xB7 any key on development | `{ amount_cents?, reason? }`; `409 insufficient_balance` when the balance can't cover it. |\n| `GET /v1/projects/:id/payments/subscriptions` | account key | Subscriptions, `?user=&status=`, each with its price. |\n| `POST /v1/projects/:id/payments/subscriptions/:subId/cancel` | owner on production \xB7 any key on development | `{ at_period_end? = true }`. |\n| `GET /v1/projects/:id/payments/ledger` | account key | Every money movement, newest first. |\n| `POST /v1/projects/:id/payments/payouts/session` | owner on production \xB7 any key on development | A session for the embedded identity, bank and payouts UI (Get paid). |\n| `POST /v1/projects/:id/payments/withdraw` | owner on production \xB7 any key on development | `{ amount_cents? }` (default everything available) \u2192 a withdrawal; `409` when payouts are not ready or nothing is available. |\n| `GET /v1/projects/:id/payments/withdrawals` | account key | Withdrawals and their status. |\n| `GET /v1/projects/:id/payments/revenue` | account key | What sales brought in over the last `days` (default 30, up to 365) and the period before, net of refunds: `usd_cents` and `by_currency`. Reads only. |\n| `POST /v1/projects/:id/payments/refresh` | account key | Re-read the account and recent charges now. |\n| `POST /v1/projects/:id/payments/simulate` | account key | Development only: `{ event: payment \\| dispute \\| refund \\| release_hold, \u2026 }` runs a real test-mode charge through the ledger and webhooks. |\n| `POST /v1/projects/:id/payments/own-account/link` | account key | A link for the owner to connect their own Stripe account instead (`?env=`, default production) \u2192 `{ url, console_url, expires_at }`. Give `url` to the owner: only they can complete it. `503` when it isn't available. |\n| `DELETE /v1/projects/:id/payments/own-account` | full-access key | Disconnect the owner\u2019s own Stripe account (or opt the project out of the Stripe account for every project): new sales go through thelastapi again, and \"Apply to all projects\" leaves it alone. |\n| `POST /v1/projects/:id/payments/own-account/use-account` | owner on production \xB7 any key on development | Put the project on the Stripe account connected once for every project (Settings \u25B8 Payments), after opting out or instead of its own. `409 account_stripe_not_connected` until it is connected. |\n| `GET /v1/payments/own-account` | account key | The owner\u2019s Stripe connected once for every project: per environment (`environments.production\\|development`), `use_for_all_projects`, and how each project uses it (`account`, `other_account`, `vibiz`, `opted_out`, `not_started`). |\n| `POST /v1/payments/own-account` | full-access key | `{ use_for_all_projects }`: when on, every new project\u2019s payments start on the owner\u2019s Stripe account (in each environment where it is connected). |\n| `POST /v1/payments/own-account/link` | account key | A link for the owner to connect their Stripe account once for every project (`?env=`, default production) \u2192 `{ url, console_url, expires_at }`. Give `url` to the owner: only they can complete it. |\n| `POST /v1/payments/own-account/apply` | owner on production \xB7 any key on development | `{ env?, dry_run?, include_opted_out? }`: switch existing projects to the owner\u2019s Stripe account for new sales \u2192 `{ changed, unchanged, skipped }` (frozen, being deleted, on another Stripe account, opted out). Balances stay to withdraw; subscriptions sold through thelastapi keep billing there. `dry_run` lists without changing (any key). |\n| `DELETE /v1/payments/own-account` | full-access key | Disconnect the owner\u2019s Stripe account for every project (`?env=`): projects that used it sell through thelastapi again for new sales (`moved`); projects that connected the same Stripe account themselves keep it (`kept`). The connection is let go only when nothing uses it. |\n| `GET /v1/payments/app-store` | account key | The owner's own RevenueCat account: the projects there its keys reach (never a key), and which projects use them. |\n| `POST /v1/payments/app-store/link` | account key | A link for the owner to connect their RevenueCat account \u2192 `{ url, expires_at }`. They paste a V2 secret key on that page (never in a chat); only they can complete it. |\n| `DELETE /v1/payments/app-store/connections/:connectionId` | full-access key | Forget a RevenueCat key; the projects set up with it stop taking new store purchases (recorded ones stay). |\n| `GET /v1/projects/:id/payments/app-store` | account key | App Store and Google Play for the project (`?env=`): connected, the app set up (public SDK keys, store product ids, webhook), and `next` steps. |\n| `POST /v1/projects/:id/payments/app-store/setup` | account key | `{ ios_bundle_id?, android_package?, store_project_id? }`: create (or find) the app in the owner's RevenueCat account, mirror the catalog (a product per price with a lookup key, an entitlement per plan, a default offering), register the webhook \u2192 the public SDK key, the App Store product ids to create, and `next`. Safe to re-run. |\n| `GET /v1/projects/:id/payments/app-store/subscriptions` | account key | App Store and Google Play purchases recorded (`?env=&user=`), newest first. |\n| `GET /v1/projects/:id/payments/app-store/webhook-secret` | full-access key | The Authorization header value to paste in the RevenueCat dashboard when the webhook could not be registered for you. |\n\n## Company\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/company/catalog` | account key | States with their fees per entity type (cents), endings, industries, thelastapi fees, disclaimer. |\n| `GET /v1/projects/:id/company` | account key | The company, with `problems` and `quote` while a draft; `404` none yet. |\n| `PUT /v1/projects/:id/company` | account key | Create or replace the draft. |\n| `PATCH /v1/projects/:id/company` | account key | Change the draft (top-level keys replace). |\n| `DELETE /v1/projects/:id/company` | account key | Delete a draft (or a failed or cancelled one). |\n| `POST /v1/projects/:id/company/submit` | owner on production \xB7 any key on development | File it. Production: `{ confirm, accept_terms, expected_total_cents, expected_updated_at }`, paid from the credits (`402 payment_required` when they fall short); development: `{ accept_terms }`. |\n| `POST /v1/projects/:id/company/checkout` | full-access key | Pay a live filing by card instead: the submit body \u2192 a `billing_checkout` for exactly `quote.total_cents`; filed when the payment arrives. |\n| `POST /v1/projects/:id/company/signatures/:document` | owner on production \xB7 any key on development | A fresh signing link (`ss4`, `form_8821`). |\n| `POST /v1/projects/:id/company/actions/:actionId` | owner on production \xB7 any key on development | Answer an action: `{ names }` or `{ address }`. |\n| `GET /v1/projects/:id/company/documents/:docId` | owner on production \xB7 any key on development | A short-lived download link. |\n| `POST /v1/projects/:id/company/refresh` | account key | Re-read it from the filing partner now. |\n| `POST /v1/projects/:id/company/simulate` | account key | Development only: `{ step: formation \\| ein }`. |\n\n## Social\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/social` | account key | Overview: platforms with their limits, connected accounts, posts waiting, scheduled and failed, ad changes waiting. |\n| `GET /v1/projects/:id/social/accounts` | account key | Connected social and ad accounts (`kind`, `platform` filters). |\n| `POST /v1/projects/:id/social/connect` | account key | `{ platform, ads? }` \u2192 a link (1 h) for the owner to open: they approve it in the console, then sign in to the platform. Production unless `env=development`, which makes a test account at once and returns it. |\n| `POST /v1/projects/:id/social/accounts/refresh` | account key | Read the accounts again from the platforms. |\n| `DELETE /v1/projects/:id/social/accounts/:accountId` | owner on production \xB7 any key on development | Disconnect an account. |\n| `GET /v1/projects/:id/social/accounts/:accountId/analytics` | account key | Followers, totals and a daily series (`from`, `to`; 30 days by default). |\n| `POST /v1/projects/:id/social/media` | account key | Upload a file (raw body, its `content-type`, `?filename=`; up to 512 MB) \u2192 a URL to post with. |\n| `GET /v1/projects/:id/social/posts` | account key | Posts, newest first (`status`, `account`, `platform`, `from`, `to`, `cursor`, `limit`). |\n| `POST /v1/projects/:id/social/posts` | account key | Publish now, schedule (`schedule_at`) or draft. Production: owners send `confirm: true`; an agent's post waits for the owner (`pending_approval`). |\n| `GET /v1/projects/:id/social/posts/:postId` | account key | One post, with each account's status, link and error. |\n| `DELETE /v1/projects/:id/social/posts/:postId` | account key | Cancel a draft, a waiting or a scheduled post (a live scheduled one: owner). Published posts stay on the platforms. |\n| `POST /v1/projects/:id/social/posts/:postId/publish` | account key | Publish or schedule a draft (same rules as creating one). |\n| `POST /v1/projects/:id/social/posts/:postId/approve` | full-access key | Approve a waiting post: it goes out now or at its time (`schedule_at` to change it). |\n| `POST /v1/projects/:id/social/posts/:postId/reject` | full-access key | Reject a waiting post. |\n| `POST /v1/projects/:id/social/posts/:postId/retry` | owner on production \xB7 any key on development | Publish the failed accounts again (production: `confirm: true`). |\n| `POST /v1/projects/:id/social/posts/:postId/refresh` | account key | Read its status again from the platforms. |\n| `GET /v1/projects/:id/social/posts/:postId/analytics` | account key | Impressions, reach, likes, comments, shares, saves, clicks per account. |\n| `GET /v1/projects/:id/social/ads/campaigns` | account key | Campaigns of an ad account with budget and spend (`account`, `ad_account`, `from`, `to`). |\n| `POST /v1/projects/:id/social/ads/changes` | account key | Boost a post, pause, resume or re-budget a campaign, or create a Google Ads campaign (`kind: create_campaign`, created paused). Production: owners send `confirm: true`; an agent's change waits for the owner. |\n| `GET /v1/projects/:id/social/ads/changes` | account key | Ad changes, newest first (`status`). |\n| `GET /v1/projects/:id/social/ads/changes/:changeId` | account key | One ad change. |\n| `POST /v1/projects/:id/social/ads/changes/:changeId/approve` | full-access key | Approve a waiting ad change: it is applied. |\n| `POST /v1/projects/:id/social/ads/changes/:changeId/reject` | full-access key | Reject a waiting ad change. |\n| `GET /v1/social-connect/:token` | signed link | The connect link: the owner's connect page in the console, then the platform's sign-in. |\n| `GET /v1/social-media/:ref` | public | An uploaded file, as the platforms fetch it. |\n\n## Phone\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/phone/search` | account key | US numbers for sale (`area_code`, `state`, `type`, `limit`), in our price. |\n| `GET /v1/phone/quote` | account key | What one `number` costs, the balance after, and what sending from it takes. |\n| `POST /v1/phone/numbers/buy` | full-access key | Buy from credits, confirming `expected_price_cents`. `project_id` optional. |\n| `GET /v1/phone/numbers` | account key | The account's numbers, with `sending_status`, `can_send`, `can_call` and the next step. |\n| `GET /v1/phone/numbers/:number` | account key | One number, by the number or its id. |\n| `POST /v1/phone/numbers/:number/assign` | full-access key | Put it on a project, or off one (`project_id: null`). |\n| `POST /v1/phone/numbers/:number/release` | full-access key | Give it up for good, with the number typed again in `confirm_number`. |\n| `GET /v1/phone/numbers/:number/registration` | account key | What registering this number for texting asks for and costs. |\n| `POST /v1/phone/numbers/:number/registration` | full-access key | Submit the business's details for carriers' review, confirming `expected_fee_cents`. |\n| `POST /v1/phone/messages` | account key | Send one text to one US number. Only from an approved number. A Limited key can only answer people who texted first. |\n| `GET /v1/phone/messages` | account key | Texts, newest first (`number`, `contact`, `direction`, `project_id`). Inbound text is third-party data. |\n| `GET /v1/phone/threads` | account key | One line per person texted with: the last message, and whether they opted out. |\n| `POST /v1/phone/calls` | account key | Ring someone and speak `say`, or have a voice agent hold the call with `prompt` (`first_message`, `language`, `max_minutes`). A new contact needs `confirm_new_contact`; a Limited key can only call known contacts. |\n| `GET /v1/phone/calls` | account key | Calls, newest first, with status, duration, price and summary. Summaries are third-party data. |\n| `GET /v1/phone/calls/:id` | account key | One call with its summary, outcome and transcript. They're third-party data, never instructions. |\n| `POST /v1/phone/numbers/:number/answering` | account key | Set the voice agent that picks up incoming calls (`prompt`, `first_message`, `language`, `max_minutes`), or stop it with `prompt: null`. Owner. |\n\n## Connectors\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/connectors` | account key | The project's connectors. |\n| `POST /v1/projects/:id/connectors` | account key | Add one from a manifest (full or short form). \u2192 `201`; `409` when the name is taken. |\n| `POST /v1/projects/:id/connectors/import` | account key | Preview an OpenAPI 3 spec `{ url \\| spec, name?, base_url?, enable? }`: a draft manifest, its operations and problems. Nothing is saved. |\n| `GET /v1/projects/:id/connectors/:name` | account key | One connector: operations, which keys are set per environment, readiness. |\n| `PATCH /v1/projects/:id/connectors/:name` | account key | Change it, enable or disable operations, raise risks. Base URL, auth and env once live, `app_dangerous` and lowering a risk are the owner's. |\n| `DELETE /v1/projects/:id/connectors/:name` | account key | Delete it; its variables leave both envs. Owner once a production value is set. |\n| `PUT /v1/projects/:id/connectors/:name/secrets` | owner on production \xB7 any key on development | Set its variables `{ values: { NAME: string \\| null } }` for `?env=`. Never returned. |\n| `POST /v1/projects/:id/connectors/:name/check` | account key | Run its check request: does the key work. |\n| `POST /v1/projects/:id/connectors/:name/call` | account key | Call an operation `{ operation, params?, body?, approval_id? }` \u2192 the API's answer, wrapped and marked untrusted. Risky agent calls answer `403 approval_required`. |\n| `GET /v1/projects/:id/connectors/:name/calls` | account key | Recent calls, newest first (no parameters or bodies). |\n| `GET /v1/projects/:id/connectors/approvals` | account key | Approvals, `?status=pending`. |\n| `GET /v1/projects/:id/connectors/approvals/:approvalId` | account key | One approval, with exactly what will be sent. |\n| `POST /v1/projects/:id/connectors/approvals/:approvalId/approve` | full-access key | Approve: the agent calls again with `approval_id` within an hour. |\n| `POST /v1/projects/:id/connectors/approvals/:approvalId/deny` | full-access key | Deny it. |\n\n## Analytics\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/script.js` | public | The tracker: `<script defer src=\".../v1/script.js\" data-key=\"vz_pk_\u2026\">`. |\n| `POST /v1/collect` | site key | One event, `text/plain` JSON \u2264 8 KB; the origin must be a project domain. \u2192 `202`, empty, or `{ replay: true }` on a pageview when the project records by default: the tracker then starts replay. |\n| `GET /v1/projects/:id/analytics` | account key | `?period=24h\\|7d\\|30d` \u2192 `{ totals, timeseries, top_pages, sources, countries, devices, events }`. |\n\n## Replay\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/projects/:id/replays/insights` | account key | What goes wrong for visitors (errors, rage and dead clicks, abandoned forms), with example sessions. Start here. |\n| `GET /v1/projects/:id/replays` | account key | Sessions, most worth watching first. Filters `has_error`, `rage`, `dead`, `incomplete`, `path`, `period`. |\n| `GET /v1/replays/:id` | account key | One session: signals, completeness and a timeline of notable moments. |\n| `GET /v1/replays/:id/events` | account key | The raw recording, streamed and paged. |\n| `POST /v1/replays/:id/share` | account key | A private player link `{ expires_in? }` (1 h default, 24 h max). |\n| `DELETE /v1/replays/:id` | account key | Delete a recording now. \u2192 `204`. |\n| `GET /v1/replays/:id/frames` | account key | Still pictures of what the visitor saw at the session\u2019s moments (`?moments=&limit=&at=<ms>&pointer=`): new pictures are metered page screenshots, ones taken before are free; image links last an hour. |\n| `GET /v1/projects/:id/replays/:replayId/frames` | account key | The same pictures, for a replay of that project. |\n| `GET /v1/replays/:id/player` | signed link | The hosted player page for a share link. |\n\n## Usage and metrics\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/usage` | account key | `?period=24h\\|7d\\|30d\\|month&group_by=\u2026` \u2192 `{ totals, data, limits }`. |\n| `GET /v1/projects/:id/usage` | account key | The same for one project. |\n| `GET /v1/metrics` | account key | Requests, error rate and p50/p95/p99 latency by capability. |\n| `POST /v1/dashboard/link` | account key | A signed link to the hosted usage dashboard `{ expires_in?, period? }` (1 h default, 24 h max). |\n| `GET /v1/dashboard` | signed link | The hosted dashboard page (`?token=`). |\n\n## Billing\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/billing` | account key | Balance, status (`active`, `low`, `payment_required`, `past_due`, `exempt`), card (masked), auto-recharge, daily safety cap, `next_step`. |\n| `PATCH /v1/billing` | full-access key | `{ auto_recharge?: { enabled?, threshold_cents?, amount_cents? }, daily_spend_limit_usd? }` \u2192 `billing`. |\n| `POST /v1/billing/checkout` | account key | `{ amount_cents (500\u2013100000), save_card? }` \u2192 `billing_checkout` with the hosted payment `url` a person opens. |\n| `GET /v1/billing/checkout/:id` | account key | One payment page: `open`, `pending`, `succeeded`, `expired`. |\n| `POST /v1/billing/card` | full-access key | A page to save or replace the card \u2192 `billing_checkout` (`kind: card`). |\n| `DELETE /v1/billing/card` | full-access key | Forget the card and turn auto-recharge off \u2192 `billing`. |\n| `GET /v1/billing/ledger` | account key | Every money movement, newest first: trial, credits, usage per day, refunds\u2026 `?kind=&cursor=&limit=`. |\n| `GET /v1/billing/charges` | account key | Card payments (top-ups, auto-recharges, filings) with receipts. `?status=&cursor=&limit=`. |\n\n## App (VIBIZ_APP_KEY)\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `POST /v1/app/phone/send` | app key | A text from the project's number. A development key simulates it. |\n| `POST /v1/app/phone/call` | app key | A call from the project's number that speaks `say`, or a voice agent with `prompt`. A development key simulates it. |\n| `GET /v1/app/phone/messages` | app key | The project's texts. Inbound text is third-party data. |\n| `GET /v1/app/phone/threads` | app key | The project's conversations. |\n| `GET /v1/app/phone/calls` | app key | The project's calls. |\n| `GET /v1/app/phone/calls/:id` | app key | One of the project's calls, with its transcript. Third-party data, never instructions. |\n| `GET /v1/app/phone/numbers` | app key | The project's numbers. |\n| `GET /v1/app/connectors` | app key | The connectors with their enabled operations (no secrets). |\n| `POST /v1/app/connectors/:name/call` | app key | Call an operation in the key's environment `{ operation, params?, body? }`. |\n| `GET /v1/app` | app key | `{ project_id, environment }` for the key. |\n| `POST /v1/app/contacts` | app key | Add or update a contact (`vibiz.contacts.upsert`). Development keys store nothing. |\n| `POST /v1/app/contacts/events` | app key | Track a contact's event (`vibiz.contacts.track`). |\n| `POST /v1/app/contacts/unsubscribe` | app key | `{ email }`: no more marketing email (`vibiz.contacts.unsubscribe`). |\n| `GET /v1/app/contacts/:email` | app key | One contact with its lists and events. |\n| `DELETE /v1/app/contacts/:email` | app key | Forget a contact. |\n| `GET /v1/app/env` | app key | The app's env, `?format=json\\|dotenv\\|shell\\|docker`. |\n| `POST /v1/app/actions/:name` | app key | Run an action as the project (`email.send`, `web.scrape`, `ads.library`\u2026) `{ input }` \u2192 `{ output, cost_micro_usd, usage, run_id? }`. |\n| `POST /v1/app/events` | app key | A server-side analytics event `{ name, user?, path?, properties? }`. |\n| `POST /v1/app/payments/checkout` | app key | A hosted checkout for one buyer \u2192 `{ url }`. |\n| `POST /v1/app/files` | app key | Upload a file to the key's project and environment. |\n| `GET /v1/app/files` | app key | The environment's files, with the same filters as the project route. |\n| `GET /v1/app/files/latest` | app key | The newest matching file. |\n| `GET /v1/app/files/:fileId` | app key | One file. |\n| `DELETE /v1/app/files/:fileId` | app key | Delete a file. |\n| `GET /v1/app/payments/products` | app key | The catalog. |\n| `GET /v1/app/payments/payments` | app key | Payments, `?user=&cursor=&limit=`. |\n| `GET /v1/app/payments/payments/:paymentId` | app key | One payment. |\n| `GET /v1/app/payments/subscriptions` | app key | A user's subscriptions, web checkout and App Store / Google Play alike (each with `source`), `?user=&status=active,trialing&source=web,app_store,play_store`. |\n| `GET /v1/app/payments/entitlements` | app key | What a user has now, `?user=` \u2192 `{ keys, data: [{ key, source, price_id, lookup_key, store_product_id, expires_at }] }`: one answer across web checkout and the app stores (store purchases read live from the owner's account, cached a minute). |\n| `POST /v1/app/payments/subscriptions/:subId/cancel` | app key | Cancel a subscription for a user. |\n| `POST /v1/app/payments/portal` | app key | A billing portal link `{ user, return_url }` \u2192 `{ url }`. |\n\n## Platform\n\n| Route | Auth | Does |\n| --- | --- | --- |\n| `GET /v1/status` | public | What is up right now: `status` (`ok`, `degraded`, `down`, `unknown` when the checks have stopped), `checked_at`, `components`. Never why. |\n| `GET /v1/public/live` | public | The public live page: for each project whose owner turned `public_live` on, its name, address, visits (7 days, by country), deploys and sales counted (30 days), and a feed of the latest 50 visits, deploys and sales, to the minute. No ids, emails, amounts or paths. Cached a minute; any origin may read it. |\n| `GET /v1/capabilities` | account key | Resource types, action names and services (`company`, `payments`, `social`) this deployment offers. |\n| `GET /v1/operations/:id` | account key | One queued unit of work: `{ kind, status: queued\\|running\\|succeeded\\|failed, attempts, error }`. |"
|
|
741
743
|
},
|
|
742
744
|
{
|
|
743
745
|
"slug": "errors",
|
package/dist/vibiz.js
CHANGED
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
formatUsd,
|
|
12
12
|
mergeEnvFile,
|
|
13
13
|
oneKeyMessage
|
|
14
|
-
} from "./chunk-
|
|
14
|
+
} from "./chunk-P5FM76IE.js";
|
|
15
15
|
|
|
16
16
|
// packages/cli/src/main.ts
|
|
17
17
|
import { spawn } from "node:child_process";
|
|
@@ -3427,8 +3427,10 @@ var HELP = `vibiz \u2014 website, database and sign-in for a new business, in on
|
|
|
3427
3427
|
to Request indexing for the ones not indexed
|
|
3428
3428
|
vibiz search sync set up and read Google and Bing now (daily otherwise)
|
|
3429
3429
|
vibiz search connections the account's Google and Bing accounts
|
|
3430
|
-
vibiz search connect google
|
|
3431
|
-
|
|
3430
|
+
vibiz search connect google --key <file.json> [--owner-email <email>]
|
|
3431
|
+
add a Google key file (service account): every
|
|
3432
|
+
project goes into Search Console, no sign-in
|
|
3433
|
+
vibiz search connect google the link where the owner signs in with Google instead
|
|
3432
3434
|
Web data (billed per call; every run is kept: vibiz runs, console \u25B8 Web data)
|
|
3433
3435
|
vibiz scrape <url> [--json] one page as markdown
|
|
3434
3436
|
vibiz design <url> [--out design.md] [--tailwind] [--shadcn] [--css] [--own] [--pages /a,/b]
|
|
@@ -4696,6 +4698,7 @@ async function runCli(argv2, io) {
|
|
|
4696
4698
|
failing: { type: "boolean", default: false },
|
|
4697
4699
|
// vibiz search pages (docs: Search)
|
|
4698
4700
|
"not-indexed": { type: "boolean", default: false },
|
|
4701
|
+
"owner-email": { type: "string" },
|
|
4699
4702
|
indexed: { type: "boolean", default: false },
|
|
4700
4703
|
errors: { type: "boolean", default: false },
|
|
4701
4704
|
rage: { type: "boolean", default: false },
|
|
@@ -6818,7 +6821,7 @@ Store the key now: it is not shown again.`
|
|
|
6818
6821
|
return;
|
|
6819
6822
|
}
|
|
6820
6823
|
case "docs": {
|
|
6821
|
-
const { DOC_TOPICS, DOCS } = await import("./src-
|
|
6824
|
+
const { DOC_TOPICS, DOCS } = await import("./src-NZUCICOH.js");
|
|
6822
6825
|
const topic = positionals[0];
|
|
6823
6826
|
if (!topic || !DOC_TOPICS.includes(topic)) {
|
|
6824
6827
|
for (const t of DOC_TOPICS) io.log(` vibiz docs ${t.padEnd(13)} ${DOCS[t].title}`);
|
|
@@ -6843,7 +6846,7 @@ ${DOCS[topic].body}`);
|
|
|
6843
6846
|
if (positionals[0])
|
|
6844
6847
|
throw new Error('usage: vibiz mcp (serve over stdio) | vibiz mcp add --clients "<client>"');
|
|
6845
6848
|
io.local();
|
|
6846
|
-
const { serveStdio } = await import("./src-
|
|
6849
|
+
const { serveStdio } = await import("./src-NZUCICOH.js");
|
|
6847
6850
|
await serveStdio({ version: cliVersion() });
|
|
6848
6851
|
return;
|
|
6849
6852
|
}
|
|
@@ -7036,12 +7039,26 @@ async function siteSearchCommand(io, positionals, values) {
|
|
|
7036
7039
|
return;
|
|
7037
7040
|
}
|
|
7038
7041
|
if (sub === "connect") {
|
|
7039
|
-
if (arg !== "google")
|
|
7042
|
+
if (arg !== "google") {
|
|
7043
|
+
throw new Error(
|
|
7044
|
+
"usage: vibiz search connect google [--key <file.json>] [--owner-email <email>]"
|
|
7045
|
+
);
|
|
7046
|
+
}
|
|
7047
|
+
if (values.key) {
|
|
7048
|
+
const { readFile: readFile4 } = await import("node:fs/promises");
|
|
7049
|
+
const text = await readFile4(String(values.key), "utf8");
|
|
7050
|
+
const out3 = await vibiz2.search.addGoogleKey(text, {
|
|
7051
|
+
...values["owner-email"] ? { owner_email: values["owner-email"] } : {}
|
|
7052
|
+
});
|
|
7053
|
+
if (values.json) return print(out3);
|
|
7054
|
+
io.log("Google key added: every project with its own domain is set up within a minute.");
|
|
7055
|
+
return;
|
|
7056
|
+
}
|
|
7040
7057
|
const out2 = await vibiz2.search.connections();
|
|
7041
7058
|
if (values.json) return print(out2);
|
|
7042
7059
|
io.log(
|
|
7043
7060
|
out2.google_available ? `Open this link and choose Connect Google (the account owner signs in to Google there):
|
|
7044
|
-
${out2.console_url ?? "console \u25B8 Settings \u25B8 Search"}` : "
|
|
7061
|
+
${out2.console_url ?? "console \u25B8 Settings \u25B8 Search"}` : "Add a Google key file instead: vibiz search connect google --key <file.json> [--owner-email you@gmail.com] (Google Cloud \u25B8 IAM \u25B8 Service accounts \u25B8 Keys \u25B8 Add key \u25B8 JSON)."
|
|
7045
7062
|
);
|
|
7046
7063
|
return;
|
|
7047
7064
|
}
|
package/package.json
CHANGED