SAGOT

Read public registration availability (closed alpha is the default) and whether the caller's session or credential is valid (signedIn).

Takes no parameters.

Request alpha participation with contact consent. Does not create an account or send email.

Platform operators only: review the alpha queue, oldest first, with status and pagination.

Platform operators only: mark an applicant waiting, contacted or closed.

Platform operators only: permanently remove an applicant's waitlist information. Does not delete their account or invitations.

Platform operators only: issue an email-bound, single-use private invitation. Returns the token once; share privately. Does not send email. Replaces prior unused invitations for that email.

Platform operators only: list invitation states without tokens, newest first.

Platform operators only: revoke an unused invitation. Existing accounts are unaffected.

SAGOT account.register. Uses the same authorization and validation as website, API and CLI.

SAGOT account.login. Uses the same authorization and validation as website, API and CLI.

SAGOT account.me. Uses the same authorization and validation as website, API and CLI.

Takes no parameters.

SAGOT account.logout. Uses the same authorization and validation as website, API and CLI.

Takes no parameters.

Signed-in session only: accept the current Terms of Service, Data Processing Addendum and Privacy Notice (version from account.me termsVersion). Records the version and time on your account.

Signed-in session only: start turning on two-step sign-in. Confirms your password and returns a new authenticator secret and otpauth:// URI (scan as a QR code). Nothing changes until account.mfaEnable confirms a code.

Signed-in session only: confirm a 6-digit code from the authenticator app to turn two-step sign-in on. Returns 10 one-time recovery codes once; store them safely. Sign-in then needs a code (account.login code).

Signed-in session only: turn two-step sign-in off with your password and a current code or recovery code. SAGOT staff cannot use the platform console without it.

Signed-in session only: replace all recovery codes after confirming a current code. Returns the 10 new codes once.

Signed-in session only: delete your own SAGOT account after confirming your password. Refused while you own a workspace (transfer ownership or delete it first) or hold a SAGOT staff role. Removes you from every workspace, revokes your sessions and API keys and anonymises your account; your email can register again.

Check an OAuth authorization request from an AI assistant (Claude, ChatGPT, Gemini or any MCP client) before consent: returns the assistant's name, the address it returns to, the scopes requested in plain words, or the problem with the request.

Signed-in session only: allow (with a workspaceId) or deny an AI assistant's request to use SAGOT. Allowing gives that assistant the listed scopes in one workspace — never admin, never more than your role — and returns redirectTo, the address to send the browser back to.

Signed-in session only: AI assistants connected to your account through OAuth, with workspace, scopes, when connected and last used.

Takes no parameters.

Signed-in session only: disconnect an AI assistant. Its access and refresh tokens stop working immediately; it must ask again to reconnect.

Signed-in session only: create an OAuth client ID and secret for an assistant that asks for them, such as Gemini Enterprise (redirect https://vertexaisearch.cloud.google.com/oauth-redirect). The secret is returned once. People who sign in through it still choose their own workspace.

Signed-in session only: OAuth client IDs you created for assistants, with their redirect addresses.

Takes no parameters.

Signed-in session only: revoke an OAuth client ID you created; assistants using it can no longer sign in or refresh tokens.

SAGOT workspaces.create. Uses the same authorization and validation as website, API and CLI.

SAGOT workspaces.list. Uses the same authorization and validation as website, API and CLI.

Takes no parameters.

SAGOT workspaces.update. Uses the same authorization and validation as website, API and CLI.

Owner only, signed-in session: choose where AI providers process this workspace's call audio and text — "eu" (European Union) or "us" (United States). No call starts until a region is chosen. Choosing it means accepting this statement: "I am the owner of this workspace. I have chosen this processing region myself and confirm it meets the data protection laws, contracts and customer commitments that apply to this workspace and the people it calls. SAGOT processes call audio and text in the region I choose and is not responsible for the consequences of choosing a region that does not meet those obligations." Applies to calls queued after the change.

Owner only, signed-in session: permanently delete this workspace and everything in it — agents, contacts, calls, recordings, transcripts, lines, API keys and members' access. confirmName must equal the workspace name. Refused while calls are active or a Twilio line exists (delete it first so SAGOT removes what it created in your Twilio account). Cannot be undone; backups expire within about 31 days.

List the people in this workspace with their roles (viewer, editor, operator, admin, owner). Admins also see invitations and their status; tokens are never shown.

Admins: invite an email to this workspace with a role, optionally limited to agentIds (viewer/editor/operator only). SAGOT emails the invitation when email is configured; the one-time link path (/join#member=…) is also returned once as a fallback. The invitee signs in or creates an account with that email. Only the owner can invite admins. Re-inviting an email replaces its earlier pending invitation.

Admins: change a member's role and, with agentIds, limit a viewer/editor/operator to selected agents (null = all agents). Takes effect on their next request, including their API keys. The owner's role cannot change; only the owner grants or removes admin.

Owner only, signed-in session: make another member the owner. You become an admin; any agent limit on them is removed. The new owner is emailed.

Admins remove a member; any member may remove themselves to leave. The owner cannot be removed. Their sessions and API keys stop working in this workspace immediately.

Admins: revoke a pending member invitation by id so its link stops working.

Public: show what a member invitation link grants (workspace, inviter, role, invited email, status) before accepting.

Signed-in account session only: accept a member invitation issued to this account's email and join the workspace with its role.

SAGOT credentials.create. Uses the same authorization and validation as website, API and CLI.

SAGOT credentials.list. Uses the same authorization and validation as website, API and CLI.

SAGOT credentials.revoke. Uses the same authorization and validation as website, API and CLI.

SAGOT agents.create. Uses the same authorization and validation as website, API and CLI.

SAGOT agents.list. Uses the same authorization and validation as website, API and CLI.

SAGOT agents.get. Uses the same authorization and validation as website, API and CLI.

SAGOT agents.save. Uses the same authorization and validation as website, API and CLI.

Validate the current draft and its integration. This is configuration validation, not a voice-quality score. Use a draft SIP call to hear the result.

Publish a validated draft for new calls. Active calls keep their original snapshot.

SAGOT agents.pause. Uses the same authorization and validation as website, API and CLI.

Point new calls to a previous published version.

SAGOT agents.retire. Uses the same authorization and validation as website, API and CLI.

SAGOT integrations.save. Uses the same authorization and validation as website, API and CLI.

SAGOT integrations.list. Uses the same authorization and validation as website, API and CLI.

SAGOT integrations.get. Uses the same authorization and validation as website, API and CLI.

Exercise the connector with a test payload. Sandbox never writes to an external product.

SAGOT integrations.disconnect. Uses the same authorization and validation as website, API and CLI.

SAGOT contacts.import. Uses the same authorization and validation as website, API and CLI.

SAGOT contacts.list. Uses the same authorization and validation as website, API and CLI.

Review all retained calls, conversations, outcomes, actions, follow-ups and activity for one contact across agents in this workspace. Missing or deleted evidence is labeled.

Export the contact's retained evidence as a readable Markdown or structured JSON audit snapshot. Export is logged; it does not create recordings or recover deleted content.

SAGOT contacts.update. Uses the same authorization and validation as website, API and CLI.

Permanently suppress this contact from new calls in this workspace.

Admins: permanently erase one person's personal data from this workspace — by contact id or by phone number (destination), including inbound callers who are not contacts. Removes the contact, its activity history, and every call's recording, transcript, outcome, number and linked action/handoff content. Calls keep only time, status, duration and cost. Refused while a call with them is active or one of their actions is unresolved. With doNotCall (always, if they had opted out) a one-way fingerprint of the number keeps them from being called or answered again. Use for data-subject erasure requests; download the audit first if you need to answer an access request.

SAGOT campaigns.save. Uses the same authorization and validation as website, API and CLI.

SAGOT campaigns.list. Uses the same authorization and validation as website, API and CLI.

SAGOT campaigns.get. Uses the same authorization and validation as website, API and CLI.

Inspect eligible contacts, exclusion reasons and the maximum reserved cost without dialing.

SAGOT campaigns.start. Uses the same authorization and validation as website, API and CLI.

SAGOT campaigns.pause. Uses the same authorization and validation as website, API and CLI.

SAGOT campaigns.resume. Uses the same authorization and validation as website, API and CLI.

SAGOT campaigns.cancel. Uses the same authorization and validation as website, API and CLI.

Queue one call with an agent to a contact. Give `task` for what this one call must achieve (the personal starter agent follows it). During the alpha a line only calls its test numbers, unless it is a SAGOT number line in live mode. Calls on SAGOT numbers reserve their maximum cost from the prepaid balance (BALANCE_TOO_LOW, SPEND_LIMIT_REACHED, COUNTRY_NOT_SUPPORTED). When an AI assistant connected by OAuth asks for a call and the policy's assistantCallApproval is on (default), the call is created with status awaiting_approval and nothing dials until a person approves it on the website: tell them, and give them the returned approvalUrl. It is canceled if not approved within 24 hours. Then read the result with calls.get.

SAGOT calls.list. Uses the same authorization and validation as website, API and CLI.

SAGOT calls.get. Uses the same authorization and validation as website, API and CLI.

Get recording availability and authenticated audio URL. Fetch that URL with the same bearer credential to play/download Ogg audio; CLI supports --output file. Older unrecorded calls have no audio.

Cancel a queued or active call. On a finished call with a scheduled automatic retry, cancels that retry instead.

Signed-in session only (a person, not an API key or assistant): approve a call an AI assistant asked for (status awaiting_approval). Eligibility is checked again and the call is queued.

Signed-in session only: decline a call an AI assistant asked for. It is canceled and its reserved budget released.

SAGOT actions.list. Uses the same authorization and validation as website, API and CLI.

Query the owning system about an uncertain action. Does not repeat the business write.

SAGOT handoffs.list. Uses the same authorization and validation as website, API and CLI.

SAGOT handoffs.update. Uses the same authorization and validation as website, API and CLI.

SAGOT events.list. Uses the same authorization and validation as website, API and CLI.

Retry delivery of this event with its original event ID.

SAGOT policies.get. Uses the same authorization and validation as website, API and CLI.

SAGOT policies.update. Uses the same authorization and validation as website, API and CLI.

SAGOT charges, reservations and credits for the workspace (PHP centavos, by line and per call in `ledger`), plus phone carrier costs (phase 44): `carrierCosts` totals per currency, `carrierPendingCalls` still waiting for the provider's price, per line `carrierCosts` and `carrierCostTracking` (provider = Twilio's actual price, line_rate = your rate on the line, included = in SAGOT's charge, not_tracked), and per call `carrierCost`. Carrier costs are billed by your carrier, not SAGOT.

The workspace's prepaid balance for calls on SAGOT numbers (PHP centavos): balance (paid top-ups + SAGOT credits − charges), reserved for calls in progress, available, this month's spend and the optional monthly cap (policy monthlySpendLimitCentavos, null = none), recent top-ups, the proposed rate per country and whether card top-ups are offered. Other line types are not paid from the balance.

Admin only, never an assistant: start a card payment (Stripe Checkout) that adds amountCentavos (₱500–₱50,000) to the prepaid balance. Returns `checkoutUrl`; give it to the person to pay. The balance rises when Stripe confirms the payment. Fails PAYMENTS_UNAVAILABLE when this deployment takes no payments.

Deprecated alias of lines.list: offered routes with health and the workspace's default line as `bound`.

Deprecated alias: add (if needed) and make default the line for this route; inboundAgentId as in lines.update.

Deprecated alias of lines.clearAlert for the workspace's default line.

List this workspace's phone lines (provider, default, mode, test numbers, ring window, live health, inbound answering, telco warning) and the providers this deployment offers. Secrets are never returned.

Read one phone line with its live health and warning.

Add a phone line from an offered provider. Adding never dials. The first line becomes the default for new calls and campaigns. Lines start in test mode: only the line's test numbers can be called. A `gateway` line (your own computer + phone) returns a one-time `pairing.code` (30 minutes) that the SAGOT gateway app exchanges for its own credential; the code is shown only once. A `twilio` line connects your own Twilio account: pass accountSid, apiKeySid, apiKeySecret (a Standard API key; write-only) and the numbers to attach (lines.twilioNumbers lists them). SAGOT creates an Elastic SIP Trunk, a credential list, an origination URL and attaches the numbers in your account, records every object it created and removes exactly those when the line is deleted. Twilio bills the calls to your account. A `sagot` line (SAGOT number, one per workspace) calls from SAGOT's shared numbers and is paid from the workspace's prepaid balance (billing.get shows rates); it can't receive calls. Add its test numbers with lines.verifyNumber and lines.confirmNumber.

Check a Twilio Standard API key (accountSid, apiKeySid, apiKeySecret) and list the account's voice-capable numbers and whether Twilio is reachable. Changes nothing and stores nothing. Use it before lines.create with provider twilio.

Rename a line, make it the default, choose the published inboundAgentId that answers its callers (gateway lines; null stops answering), set testNumbers (customer gateway and Twilio lines), rotatePairing to issue a new pairing code and sign the paired device out, or capacity (Twilio lines: concurrent calls 1–10; phone gateways, SAGOT numbers and shared routes carry one call). The deployment also caps concurrent calls overall. On a SAGOT number line testNumbers can only remove numbers (add them with lines.verifyNumber). `carrierRate` {amountPerMinute, currency, increment minute|second} (null clears) records what your carrier charges on lines whose provider doesn't report prices (phone gateway SIM): calls then show an estimated carrier cost. Twilio lines report Twilio's actual price instead; SAGOT number lines include telecom in SAGOT's charge. `mode: "live"` (admin, not an assistant) lets a SAGOT number line call any number in a supported country once SAGOT has turned live calling on; otherwise it fails LIVE_MODE_UNAVAILABLE.

SAGOT number lines, admin only (never an assistant): send a verification code to a phone number the person owns, by SMS (default) or a voice call (`channel: "call"`). Then call lines.confirmNumber with the code. Verified numbers can be called in test mode.

SAGOT number lines, admin only: check the code sent by lines.verifyNumber and add the number to the line's test numbers. A wrong or expired code fails VERIFICATION_FAILED; send a new one.

Check a line's readiness without dialing: provider offered, health, test numbers. Use calls.create with lineId for a real test call.

Clear this line's telco warning after fixing the cause (for example topping up the gateway SIM). Held automatic retries and campaigns on this line resume. An answered call also clears it.

Remove a phone line. Refused while it has active calls. For a Twilio line SAGOT first deletes the trunk, credentials and origination URL it created in your account and detaches your numbers (the numbers stay yours). Finished calls keep their history; scheduled retries on it are skipped. Another line becomes the default if needed.

SAGOT artifacts.export. Uses the same authorization and validation as website, API and CLI.

SAGOT artifacts.delete. Uses the same authorization and validation as website, API and CLI.

Platform staff only (account session). Platform totals: accounts, workspaces (active/suspended), calls today and in 30 days, connected minutes, active calls, charges, lines with problems, pending support requests and waitlist.

Takes no parameters.

Platform staff only (account session). Health of the database, worker, media (LiveKit), email outbox and paired gateway devices, with the deployment's concurrent-call ceiling and current active calls. Read-only.

Takes no parameters.

Platform staff only (account session). People with a platform role (owner, admin, support, finance). Bootstrap owners come from the server configuration and cannot be revoked here.

Takes no parameters.

Platform staff only (account session). Requires the staff scope. Give an existing account (by email) a platform role. Owners grant any role; admins grant support or finance. Replaces the account's earlier platform role. Takes effect on the next request.

Platform staff only (account session). Requires the staff scope. Remove an account's platform role. Admins cannot revoke owners or admins; the last owner and bootstrap owners cannot be removed.

Platform staff only (account session). Append-only log of platform actions and staff reads under support access, newest first; filter by actorId, targetId or operation.

Platform staff only (account session). Every workspace with owner, members, lines, 30-day calls and charges, status and limits. Search by workspace name or owner email. No customer content.

Platform staff only (account session). One workspace: owner, members and roles, lines with health, agents, 30-day usage, calling policy summary, suspension, limits, credits and recent platform actions. No transcripts, recordings or contact details.

Platform staff only (account session). Requires manage. Suspend a workspace with a reason shown to its members: they can still read and export, every other action fails WORKSPACE_SUSPENDED, queued outbound calls are canceled and inbound calls are not answered.

Platform staff only (account session). Requires manage. Lift a workspace suspension. Calls canceled during the suspension stay canceled.

Platform staff only (account session). Requires manage. Cap how many calls the workspace carries at once across all its lines (1–50, null = no workspace cap). Line capacity and the deployment ceiling still apply.

Platform staff only (account session). Every account with email, name, created time, workspaces, platform role and suspension. Search by email or name.

Platform staff only (account session). One account: workspaces with roles, platform role, active sessions and API keys count, suspension.

Platform staff only (account session). Requires manage. Suspend an account: its sessions and API keys stop working and sign-in is refused until reactivated. You cannot suspend yourself or a platform owner.

Platform staff only (account session). Requires manage. Allow the account to sign in again. Revoked sessions and API keys stay revoked; the person signs in again and creates new keys.

Platform staff only (account session). Phone lines across workspaces with provider, mode, capacity, live health, telco warning and active calls. problems=true lists only lines that are unhealthy or have a warning. Never returns secrets.

Platform staff only (account session). Call metadata across workspaces, newest first: workspace, direction, line, status, outcome, duration, charge. Numbers are masked; no transcripts or recordings.

Platform staff only (account session). SAGOT's platform do-not-call list.

Platform staff only (account session). Requires manage. Add a number to the platform do-not-call list: no workspace can call it; queued calls to it are canceled. Customers see only that the number is on SAGOT's do-not-call list.

Platform staff only (account session). Requires manage. Remove a number from the platform do-not-call list.

Platform staff only (account session). Usage for a month (YYYY-MM, default this month) per workspace: calls, connected minutes, charges, credits and net, with platform totals. Rates are proposed (docs/11); no payment is collected.

Platform staff only (account session). Requires billing. Credit a workspace (centavos, PHP) with a reason the customer sees. Credits are append-only; correct one with a negative amount.

Platform staff only (account session). Credits granted, newest first; filter by workspaceId.

Platform staff only (account session). Platform switches: managedLiveCalling (SAGOT number lines in live mode may call any number in a supported country) and whether payments and SAGOT numbers are configured on this deployment.

Takes no parameters.

Platform staff only (account session). Requires manage. Turn live calling from SAGOT numbers on or off for every workspace. Off: live-mode SAGOT lines call only their verified numbers again, effective before the next dial. Audited.

Platform staff only (account session). Requires support. Ask a workspace's owner and admins for read-only support access for 1–72 hours, with a reason they see. Nothing is accessible until they approve.

Platform staff only (account session). Your support access requests and grants with status (pending, active, denied, expired, ended — withdrawn or revoked) and expiry.

Platform staff only (account session). End your own pending request or active support access early.

Platform staff only (account session). Requires manage. Email every workspace owner (one email per person) that SAGOT will add or replace a sub-processor on effectiveOn — at least 30 days ahead, as the Data Processing Addendum promises — with how to object. Describe what changes, its purpose and location in change. Audited.

Workspace admins: SAGOT support access requests and grants for this workspace, with what staff read while access was active.

Workspace admins: approve a pending SAGOT support access request. The staff member gets read-only access for the requested hours, starting now. Nothing can be changed by staff.

Workspace admins: deny a pending SAGOT support access request.

Workspace admins: end active SAGOT support access immediately.