Register, renew, transfer, and manage domains, DNS, VPS, and email with 106 tools. By OSIR.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
addPrefixToDomain: Generate domain suggestions by adding prefixes to a base name.
Base name to prefix, e.g. "mycompany".
Language code; default "eng".
Comma-separated TLDs without leading dots, e.g. "com,net".
Maximum suggestions to return; default 20.
Prefix vocabulary: "@prefixes" or a custom comma-separated list.
addPrefixToDomain: Generate domain suggestions by adding prefixes to a base name.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language code; default "eng". |
| name* | string | Base name to prefix, e.g. "mycompany". |
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| maxResults | integer | Maximum suggestions to return; default 20. |
| vocabulary | string | Prefix vocabulary: "@prefixes" or a custom comma-separated list. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"lang": {
"type": "string",
"description": "Language code; default \"eng\"."
},
"name": {
"type": "string",
"description": "Base name to prefix, e.g. \"mycompany\"."
},
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"maxResults": {
"type": "integer",
"description": "Maximum suggestions to return; default 20."
},
"vocabulary": {
"type": "string",
"description": "Prefix vocabulary: \"@prefixes\" or a custom comma-separated list."
}
}
}addSshKey: Store an SSH public key on your account so it can be injected into VPS installs. Idempotent: storing a key you already have returns the existing one instead of creating a duplicate, so it is safe to call before every order. Returns the key id to pass to orderVps or buildVpsInstance. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| name* | string | A label for the key, e.g. 'laptop'. |
| publicKey* | string | The full single-line OpenSSH public key, e.g. 'ssh-ed25519 AAAA... user@host'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"name",
"publicKey"
],
"properties": {
"name": {
"type": "string",
"description": "A label for the key, e.g. 'laptop'."
},
"publicKey": {
"type": "string",
"description": "The full single-line OpenSSH public key, e.g. 'ssh-ed25519 AAAA... user@host'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}addSuffixToDomain: Generate domain suggestions by adding suffixes to a base name.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language code; default "eng". |
| name* | string | Base name to suffix, e.g. "mycompany". |
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| maxResults | integer | Maximum suggestions to return; default 20. |
| vocabulary | string | Suffix vocabulary: "@suffixes" or a custom comma-separated list. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"lang": {
"type": "string",
"description": "Language code; default \"eng\"."
},
"name": {
"type": "string",
"description": "Base name to suffix, e.g. \"mycompany\"."
},
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"maxResults": {
"type": "integer",
"description": "Maximum suggestions to return; default 20."
},
"vocabulary": {
"type": "string",
"description": "Suffix vocabulary: \"@suffixes\" or a custom comma-separated list."
}
}
}buildVpsInstance: Stage an operating system install (or reinstall) on a VPS instance. DESTRUCTIVE: ERASES ALL DATA on the server, including any deployed application, and cannot be undone. The install is asynchronous; afterwards poll getVpsInstanceDetails until buildState is COMPLETE. If an Osir app was deployed onto this instance, a rebuild erases it; re-attach it afterwards with osirAppDeployToVps. Never rebuild a box just to install an app runtime by hand. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| swap | number | Swap size: 256, 512, or 768 (MB), or 1, 1.5, 2, 3, 4, 5, 6, or 8 (GB). |
| hostname | string | Hostname for the rebuilt server; defaults to the instance's current hostname. |
| sshKeyIds | array | Integer SSH key ids from listMySshKeys, injected during install; without one you may not be able to log in. |
| instanceId* | string | VPS instance id from listMyVpsInstances. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| operatingSystemId* | integer |
bulkDomainSuggestions: Generate domain suggestions for 1-10 keywords across 1-6 TLDs (hard cap), grouped by originating keyword. Typical flow: call listCategorizedTlds first to pick 3-6 TLDs, then this tool. Per-suggestion availability may be "available", "taken", or "unknown"; confirm "unknown" or premium-TLD names with checkDomainAvailability before recommending.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language code; default "eng". |
| tlds* | array | 1-6 TLDs without leading dots (use "tech", not ".tech"), chosen from listCategorizedTlds. |
| keywords* | array | 1-10 keywords describing the project. |
| maxResults | integer | Maximum suggestions per keyword; default 20. |
{
"type": "object",
"required": [
"keywords",
"tlds"
],
"properties": {
"lang": {
"type": "string",
"description": "Language code; default \"eng\"."
},
"tlds": {
"type": "array",
"items": {
"type": "string"
},
"description": "1-6 TLDs without leading dots (use \"tech\", not \".tech\"), chosen from listCategorizedTlds."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "1-10 keywords describing the project."
},
"maxResults": {
"type": "integer",
"description": "Maximum suggestions per keyword; default 20."
}
}
}cancelTransfer: Stage cancellation of a pending domain transfer. DESTRUCTIVE and irreversible once executed. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name whose pending transfer to cancel, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name whose pending transfer to cancel, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}changeVpsPaymentTerm: Stage a change of the payment term (billing cycle) for a VPS instance. Affects what you are billed. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string | VPS instance id from listMyVpsInstances. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| paymentTerm* | string | New billing cycle: 'MONTHLY', 'SEMI_ANNUAL', 'ANNUAL', 'BIENNIAL', or 'TRIENNIAL'. |
{
"type": "object",
"required": [
"instanceId",
"paymentTerm"
],
"properties": {
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"paymentTerm": {
"type": "string",
"description": "New billing cycle: 'MONTHLY', 'SEMI_ANNUAL', 'ANNUAL', 'BIENNIAL', or 'TRIENNIAL'."
}
}
}checkDeviceLoginStatus: Poll for device login completion. Call this after loginWithDevice() once you have opened the verification URL and signed in. Required: deviceCode (the device_code returned by loginWithDevice). On success returns a sessionKey; pass it as the sessionKey argument on every subsequent authenticated tool call.
| Argument | Type | Description |
|---|---|---|
| deviceCode* | string | The device_code value returned by loginWithDevice. |
{
"type": "object",
"required": [
"deviceCode"
],
"properties": {
"deviceCode": {
"type": "string",
"description": "The device_code value returned by loginWithDevice."
}
}
}checkDomainAvailability: Check if a domain name is available for registration, with price. No authentication required; anonymous callers get list pricing, authenticated callers get their account pricing. Required: domain (e.g., 'example.com')
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to check, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to check, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}checkHostAvailability: Check if a host/glue record name is available for creation. Requires authentication. Returns whether the hostname is free; call before createHost.
| Argument | Type | Description |
|---|---|---|
| hostname* | string | Fully qualified host name to check, e.g. 'ns1.example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"hostname"
],
"properties": {
"hostname": {
"type": "string",
"description": "Fully qualified host name to check, e.g. 'ns1.example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}checkKeywordAvailability: Check keyword availability across all supported TLDs and registries with detailed per-domain results. Use checkKeywordAvailabilitySummary instead when you only need counts; it is faster.
| Argument | Type | Description |
|---|---|---|
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| keyword* | string | Keyword to check, without a TLD, e.g. "example". |
| registries | string | Comma-separated registry filter, e.g. "verisign,pir,id,centralnic". |
{
"type": "object",
"required": [
"keyword"
],
"properties": {
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"keyword": {
"type": "string",
"description": "Keyword to check, without a TLD, e.g. \"example\"."
},
"registries": {
"type": "string",
"description": "Comma-separated registry filter, e.g. \"verisign,pir,id,centralnic\"."
}
}
}checkKeywordAvailabilitySummary: Check keyword availability across TLDs and registries. Summary statistics only (no per-domain results), faster than checkKeywordAvailability.
| Argument | Type | Description |
|---|---|---|
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| keyword* | string | Keyword to check, without a TLD, e.g. "example". |
| registries | string | Comma-separated registry filter, e.g. "verisign,pir". |
{
"type": "object",
"required": [
"keyword"
],
"properties": {
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"keyword": {
"type": "string",
"description": "Keyword to check, without a TLD, e.g. \"example\"."
},
"registries": {
"type": "string",
"description": "Comma-separated registry filter, e.g. \"verisign,pir\"."
}
}
}countMyVpsInstances: Get the total count of VPS instances owned by the authenticated user. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}createAccount: Create a new OSIR customer account; step 1 of onboarding, no authentication required. The contact must be the PRINCIPAL's real ICANN registrant contact (the human or business the account is for), never the AI agent itself. Sends a verification email; complete via verifyAccount with the emailed code. While PENDING_VERIFICATION the account can search, quote and fund; billable actions need ACTIVE. Calling again for a PENDING account re-sends the verification email.
| Argument | Type | Description |
|---|---|---|
| email* | string | Account login email; valid mailbox that receives the verification code. |
| contact* | object | The principal's real ICANN registrant contact (firstName, lastName, email, phone, street1, city, country), never the AI agent itself. |
| password | string | Optional account password; if omitted the account is agent-managed until a password is set. |
| agentName | string | Name of the AI agent acting for the principal, recorded for the audit trail. |
| accountType* | string | Account type: INDIVIDUAL or ORGANIZATION. |
| agentVendor | string | Vendor of the AI agent acting for the principal, recorded for the audit trail. |
| termsVersion* | string |
createContact: Create a new contact for use with domain registrations. Requires authentication. Returns the created contact including its id for assignment to domains.
| Argument | Type | Description |
|---|---|---|
| city* | string | City name. |
| email* | string | Contact's email address. |
| phone* | string | Phone number in '+CC.number' format, e.g. '+1.5551234567'. |
| state | string | State, province, or region, if applicable. |
| country* | string | Country as a 2-letter ISO 3166-1 alpha-2 code, e.g. 'US'. |
| street1* | string | First street address line. |
| street2 | string | Second street address line, if needed. |
| lastName* | string | Contact's last name. |
| firstName* | string | Contact's first name. |
createDnsRecord: Create a new DNS record for a domain. Requires authentication. For newly registered domains the zone is initialized automatically if missing. Returns the created record including its id for later updates or deletion.
| Argument | Type | Description |
|---|---|---|
| ttl | integer | Time to live in seconds; defaults to 3600 when omitted. |
| name* | string | Record name relative to the zone, e.g. 'www', 'mail', or '@' for the apex. |
| type* | string | Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA. |
| domain* | string | Fully qualified domain name the record belongs to, e.g. 'example.com'. |
| content* | string | Record value, e.g. an IPv4 dotted-quad or IPv6 address for A/AAAA, a hostname for CNAME/MX/NS, or text for TXT. |
| priority | integer | Priority for MX/SRV records only; defaults to 0 when omitted. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
createHost: Create a new host/glue record, e.g. for custom nameservers like 'ns1.example.com'. Requires authentication. Check the name first with checkHostAvailability. Returns the created host record.
| Argument | Type | Description |
|---|---|---|
| hostname* | string | Fully qualified host name to create, e.g. 'ns1.example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| ipAddresses* | array | IP addresses for the host, IPv4 dotted-quad or IPv6, e.g. ['192.0.2.1', '198.51.100.1']. |
{
"type": "object",
"required": [
"hostname",
"ipAddresses"
],
"properties": {
"hostname": {
"type": "string",
"description": "Fully qualified host name to create, e.g. 'ns1.example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"ipAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "IP addresses for the host, IPv4 dotted-quad or IPv6, e.g. ['192.0.2.1', '198.51.100.1']."
}
}
}createMailbox: Stage creation of a paid mailbox on a mail-enabled domain. BILLABLE: deducts from account balance; get a quote with getMailboxQuote and confirm the price with the user first. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve. The result of the confirmed action contains the generated password EXACTLY ONCE; it can never be retrieved again, so show it to the user immediately (they can change it later with setMailboxPassword). Also share the client settings from the result (IMAP/SMTP/webmail).
| Argument | Type | Description |
|---|---|---|
| term | string | Payment term: 'MONTHLY' or 'ANNUAL' (default ANNUAL). |
| domain* | string | An ACTIVE mail-enabled domain from listMailDomains. |
| localPart* | string | The part of the address before the @; the full mailbox address becomes 'localPart@domain', e.g. '[email protected]'. |
| packageId* | string | Mailbox plan id from listMailPlans; there is no default. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"localPart",
"packageId"
],
"properties": {
"term": {
"type": "string",
"description": "Payment term: 'MONTHLY' or 'ANNUAL' (default ANNUAL)."
},
"domain": {
"type": "string",
"description": "An ACTIVE mail-enabled domain from listMailDomains."
},
"localPart": {
"type": "string",
"description": "The part of the address before the @; the full mailbox address becomes 'localPart@domain', e.g. '[email protected]'."
},
"packageId": {
"type": "string",
"description": "Mailbox plan id from listMailPlans; there is no default."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}createPaymentSession: Stage a Stripe checkout session to add funds to the account balance. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve. The executed result includes checkoutUrl (hand it to the human to pay) and expiresAt; then poll getPaymentTransactions until the balance credit appears.
| Argument | Type | Description |
|---|---|---|
| amount* | number | Amount to add to the balance, in the account currency as a decimal (e.g. 25.00). |
| currency | string | 3-letter ISO 4217 currency code, default USD. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "Amount to add to the balance, in the account currency as a decimal (e.g. 25.00)."
},
"currency": {
"type": "string",
"description": "3-letter ISO 4217 currency code, default USD."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteContact: Stage deletion of a contact. DESTRUCTIVE; fails if the contact is assigned to active domains. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| contactId* | string | Identifier of the contact to delete, as returned by listContacts. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"contactId": {
"type": "string",
"description": "Identifier of the contact to delete, as returned by listContacts."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteDnsRecord: Stage deletion of a DNS record. DESTRUCTIVE and irreversible once executed. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name the record belongs to, e.g. 'example.com'. |
| recordId* | string | Identifier of the record to delete, as returned by listDnsRecords. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"recordId"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name the record belongs to, e.g. 'example.com'."
},
"recordId": {
"type": "string",
"description": "Identifier of the record to delete, as returned by listDnsRecords."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteHost: Stage deletion of a host/glue record. DESTRUCTIVE and irreversible once executed. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| hostname* | string | Fully qualified host name to delete, e.g. 'ns1.example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"hostname"
],
"properties": {
"hostname": {
"type": "string",
"description": "Fully qualified host name to delete, e.g. 'ns1.example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteMailbox: Stage deletion of a mailbox. The mailbox stops working immediately and its data is destroyed after a 14-day grace period. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| mailboxId* | string | Mailbox id from listMailboxes. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"mailboxId"
],
"properties": {
"mailboxId": {
"type": "string",
"description": "Mailbox id from listMailboxes."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteSshKey: Stage removal of an SSH key from your account. This does not affect servers already built with it, and the key can simply be added again. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| keyId* | integer | Integer key id from listMySshKeys. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"keyId"
],
"properties": {
"keyId": {
"type": "integer",
"description": "Integer key id from listMySshKeys."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}deleteVpsInstance: Stage deletion/cancellation of a VPS instance. DESTRUCTIVE and irreversible. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string | VPS instance id from listMyVpsInstances. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"instanceId"
],
"properties": {
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}enableMailDomain: Enable email hosting on a domain you own. Free; mailboxes are what cost money. If the call fails with a DNS conflict (an existing SPF or MX record), ask the user for explicit consent, then re-call with spfMergeConfirmed=true and/or takeoverConfirmed=true. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The domain to enable email hosting on, e.g. 'example.com'. |
| dnsMode | string | 'PDNS_AUTO' (default) publishes all mail DNS records automatically; the domain must use our nameservers. 'EXTERNAL_MANUAL' returns the DNS records for you to publish at your DNS provider, and the domain stays PENDING_DNS until verifyMailDns succeeds. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| spfMergeConfirmed | boolean | Set true, only with the user's explicit consent, to replace a foreign SPF record. |
| takeoverConfirmed | boolean | Set true, only with the user's explicit consent, to repoint a foreign MX record; this moves their live email. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain to enable email hosting on, e.g. 'example.com'."
},
"dnsMode": {
"type": "string",
"description": "'PDNS_AUTO' (default) publishes all mail DNS records automatically; the domain must use our nameservers. 'EXTERNAL_MANUAL' returns the DNS records for you to publish at your DNS provider, and the domain stays PENDING_DNS until verifyMailDns succeeds."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"spfMergeConfirmed": {
"type": "boolean",
"description": "Set true, only with the user's explicit consent, to replace a foreign SPF record."
},
"takeoverConfirmed": {
"type": "boolean",
"description": "Set true, only with the user's explicit consent, to repoint a foreign MX record; this moves their live email."
}
}
}executeConfirmedAction: Execute a previously staged destructive or financial action after user approval. The action expires after 5 minutes and can only be executed once.
| Argument | Type | Description |
|---|---|---|
| actionId* | string | The action UUID from the staging tool's response. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"actionId"
],
"properties": {
"actionId": {
"type": "string",
"description": "The action UUID from the staging tool's response."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}fundBalanceWithSharedPaymentToken: Stage adding funds to the balance by charging a Stripe Shared Payment Token the customer granted to OSIR. Use when a purchase (registerDomain, renewDomain, transferDomain, orderVps) failed for insufficient funds: that error tells you the networkId to mint against and both amounts. Mint the token for the GROSS and pass the NET as creditCents. Tokens are single-use. Requires authentication. Returns an actionId; tell the user what the card will be charged, then call executeConfirmedAction with the actionId if they approve. If this fails in any way you cannot fix by minting a fresh token, fall back to createPaymentSession and give the user the checkout URL.
| Argument | Type | Description |
|---|---|---|
| currency | string | 3-letter ISO 4217 currency code, default USD. Must match the balance currency. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| creditCents* | integer | NET amount to land in the balance, in minor units (cents). Use fundNetCents from the insufficient-funds error. The card is charged this plus the processing fee. |
| description | string | What the funds are for, e.g. 'Funding registration of example.com'. Lands on the customer's transaction record. |
| maxChargeCents | integer | The usage_limits max_amount the token was minted with, i.e. fundGrossCents. Supplying it lets OSIR reject an impossible charge without calling Stripe. |
generateDomainSuggestions: Generate domain name suggestions based on keywords. This is the preferred suggestion tool for a single keyword; use it over suggestAlternatives. Returns suggested names with availability.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language code; default "eng". |
| name* | string | Keyword or base name to build suggestions from, e.g. "mycompany". |
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| maxResults | integer | Maximum suggestions to return; default 20. |
| useNumbers | boolean | Allow digits in generated suggestions (true/false). |
{
"type": "object",
"required": [
"name"
],
"properties": {
"lang": {
"type": "string",
"description": "Language code; default \"eng\"."
},
"name": {
"type": "string",
"description": "Keyword or base name to build suggestions from, e.g. \"mycompany\"."
},
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"maxResults": {
"type": "integer",
"description": "Maximum suggestions to return; default 20."
},
"useNumbers": {
"type": "boolean",
"description": "Allow digits in generated suggestions (true/false)."
}
}
}getAccountBalance: Get the current account balance for the authenticated user. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getAccountSummary: Get a comprehensive summary of the user's account: profile, balance, domain count, VPS count, and pending transfers. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getAuthStatus: Check whether the current session is authenticated. Returns authenticated status and token expiry. Optional: sessionKey (from checkDeviceLoginStatus).
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getContact: Get detailed information about a specific contact. Requires authentication. Get the contactId from listContacts. Returns name, email, phone, organization, and address.
| Argument | Type | Description |
|---|---|---|
| contactId* | string | Identifier of the contact to fetch, as returned by listContacts. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"contactId": {
"type": "string",
"description": "Identifier of the contact to fetch, as returned by listContacts."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getContactsForDomain: Get all contacts (registrant, admin, tech, billing) assigned to a domain. Requires authentication. Returns the contact assigned to each role.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name whose contacts to fetch, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name whose contacts to fetch, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getDedicatedServerCatalog: Get all available dedicated server configurations with pricing and specifications. No authentication required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}getDnsRecord: Get details of a specific DNS record by id. Requires authentication. Get the recordId from listDnsRecords. Returns the record's name, type, content, TTL, and priority.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name the record belongs to, e.g. 'example.com'. |
| recordId* | string | Identifier of the record to fetch, as returned by listDnsRecords. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"recordId"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name the record belongs to, e.g. 'example.com'."
},
"recordId": {
"type": "string",
"description": "Identifier of the record to fetch, as returned by listDnsRecords."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getDomainAuditTrail: Get the audit trail (history of all changes) for a specific domain. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to fetch the audit trail for (e.g. 'example.com'). |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to fetch the audit trail for (e.g. 'example.com')."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getDomainExtensions: Get all available domain extensions (TLDs) with pricing information. No authentication required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}getDomainInfo: Get registry (EPP) state plus account settings for one domain: status, nameservers, lock state, auto-renew, privacy, creation/expiry dates, premium/expired/redemption info. Dates are null while a registration is still pending at the registry; autoRenew is omitted for transferredOut domains.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getDomainPricing: Get pricing for domain extensions from the product catalog. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| extension | string | Domain extension to filter by, without the leading dot (e.g. 'com', 'net', 'org'). |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"extension": {
"type": "string",
"description": "Domain extension to filter by, without the leading dot (e.g. 'com', 'net', 'org')."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getHostingBundle: Get the hosting options and exact prices for a specific domain: recommended VPS packages (cheapest first), email plans, web forwarding, and app/site deployment. No authentication required. Call this ONCE after a successful availability check or registration to make a concise hosting offer; do not repeat the offer in the same conversation. Prices are display prices; the authoritative amount is computed at purchase.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to get hosting options for (e.g. 'example.com'). |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to get hosting options for (e.g. 'example.com')."
}
}
}getHostsForDomain: List all host/glue records associated with a domain. Requires authentication. Returns each host name and its IP addresses.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name whose host records to list, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name whose host records to list, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getInvoiceDetails: Get detailed information about a specific invoice including line items. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| invoiceId* | string | The identifier of the invoice to fetch, as returned by listInvoices. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "The identifier of the invoice to fetch, as returned by listInvoices."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getInvoiceStatistics: Get summary statistics of invoices: total paid, pending, overdue amounts. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getMailDnsRecords: Get the DNS records a mail domain needs (MX, SPF, DKIM, ...), for customers managing DNS externally. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A mail-enabled domain from listMailDomains, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "A mail-enabled domain from listMailDomains, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getMailboxQuote: Get a display-only price quote for a mailbox plan. The backend re-derives the authoritative price at purchase. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| term | string | Payment term: 'MONTHLY' or 'ANNUAL' (default ANNUAL). |
| packageId* | string | Mailbox plan id from listMailPlans. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"packageId"
],
"properties": {
"term": {
"type": "string",
"description": "Payment term: 'MONTHLY' or 'ANNUAL' (default ANNUAL)."
},
"packageId": {
"type": "string",
"description": "Mailbox plan id from listMailPlans."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getMailboxUsage: Get disk usage per mailbox in bytes, for quota display alongside the plan's quotaBytes. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getMyAuditLogs: Get recent audit logs for the authenticated user across all services. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number for pagination. |
| size | integer | Number of log entries per page. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "Zero-based page number for pagination."
},
"size": {
"type": "integer",
"description": "Number of log entries per page."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getMyProfile: Get the authenticated user's profile and account information including name, email, organization, balance, and domain/VPS counts. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getPaymentTransactions: Get payment transaction history for the authenticated user. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number for pagination. |
| size | integer | Number of transactions per page. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "Zero-based page number for pagination."
},
"size": {
"type": "integer",
"description": "Number of transactions per page."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getProductCatalog: Get the complete product catalog including domain extensions, VPS packages, and dedicated servers. No authentication required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}getRecentActivity: Get the most recent activity across all domains and services for the user. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getTransferQuote: Get a transfer price quote for a domain. Requires authentication. Returns transfer price, currency, extension years, and new expiration date. Call before initiateTransfer to show the user the cost.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to quote, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to quote, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getTransferStatus: Check the current status of a domain transfer. Requires authentication. Returns status, request date, current registrar, and expected completion.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name whose transfer to check, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name whose transfer to check, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getVpsInstanceDetails: Get detailed information about a specific VPS instance including resource usage. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string | VPS instance id from listMyVpsInstances. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"instanceId"
],
"properties": {
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}getVpsPackageDetails: Get detailed information about a specific VPS package including all pricing tiers. Requires authentication. For anonymous browsing use listVpsPackages, which already includes per-term pricing.
| Argument | Type | Description |
|---|---|---|
| packageId* | string | VPS package id from listVpsPackages. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"packageId"
],
"properties": {
"packageId": {
"type": "string",
"description": "VPS package id from listVpsPackages."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}initializeDnsZone: Initialize (create) the DNS zone for a domain. NOT needed after registerDomain, which initializes the zone automatically. Use only for pre-existing domains without a zone (e.g. after a transfer, or if registration opted out with initializeDnsZone:false). Safe on existing zones, it will not overwrite records. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to create the zone for, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to create the zone for, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}initiateTransfer: Starts a transfer for a domain already prepared at the losing registrar (unlocked, auth code in hand). transferDomain (domain tools) stages transfer + registrant assignment in one step; use that when the user gives you contact details. Deducts from account balance. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to transfer in, e.g. 'example.com'. |
| authCode* | string | EPP/transfer authorization code obtained from the losing registrar. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"authCode"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to transfer in, e.g. 'example.com'."
},
"authCode": {
"type": "string",
"description": "EPP/transfer authorization code obtained from the losing registrar."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listCategorizedTlds: List TLDs from the OSIR catalog that have category and audience metadata, with registration and renewal prices as decimal strings (e.g. '10.39'). Use it to pick 3-6 relevant TLDs before calling bulkDomainSuggestions. Filters: price cap, exclude ccTLDs/restricted/premium, registry. Returns unranked candidates with categories, audience, prices, and flags. No auth required.
| Argument | Type | Description |
|---|---|---|
| registry | string | Filter to TLDs operated by this registry name (case-insensitive exact match). |
| excludeCcTLDs | boolean | Set true to exclude country-code and IDN TLDs. |
| excludePremium | boolean | Set true only when the user explicitly asks for no premium or surprise pricing; premium-flagged TLDs still register most names at the standard price, so do not use this as a budget filter. |
| maxRegisterPrice | number | Maximum registration price as a decimal; TLDs priced above it are excluded. |
| excludeRestricted | boolean | Set true to exclude TLDs with registry-level registration restrictions. |
{
"type": "object",
"required": [],
"properties": {
"registry": {
"type": "string",
"description": "Filter to TLDs operated by this registry name (case-insensitive exact match)."
},
"excludeCcTLDs": {
"type": "boolean",
"description": "Set true to exclude country-code and IDN TLDs."
},
"excludePremium": {
"type": "boolean",
"description": "Set true only when the user explicitly asks for no premium or surprise pricing; premium-flagged TLDs still register most names at the standard price, so do not use this as a budget filter."
},
"maxRegisterPrice": {
"type": "number",
"description": "Maximum registration price as a decimal; TLDs priced above it are excluded."
},
"excludeRestricted": {
"type": "boolean",
"description": "Set true to exclude TLDs with registry-level registration restrictions."
}
}
}listContacts: List all contacts for the authenticated user, optionally filtered by a search term. Requires authentication. Returns each contact with its id for use in getContact, updateContact, deleteContact, or domain registration.
| Argument | Type | Description |
|---|---|---|
| search | string | Optional search term matched against contact name, email, or organization. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"search": {
"type": "string",
"description": "Optional search term matched against contact name, email, or organization."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listDnsRecords: List all DNS records for a domain. Requires authentication. Returns each record with its id, name, type, content, TTL, and priority; use the record id with getDnsRecord, updateDnsRecord, or deleteDnsRecord.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name whose records to list, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name whose records to list, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listInvoices: List invoices for the authenticated user with optional status filtering and pagination. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| page | integer | Zero-based page number for pagination, default 0. |
| size | integer | Number of invoices per page, default 20. |
| status | string | Filter by invoice status: DRAFT, PENDING, PAID, CANCELLED, or OVERDUE. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"page": {
"type": "integer",
"description": "Zero-based page number for pagination, default 0."
},
"size": {
"type": "integer",
"description": "Number of invoices per page, default 20."
},
"status": {
"type": "string",
"description": "Filter by invoice status: DRAFT, PENDING, PAID, CANCELLED, or OVERDUE."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listMailDomains: List your domains that are enabled for email hosting, with status (PENDING_DNS or ACTIVE) and DNS mode. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listMailPlans: List available email mailbox plans with quotas and prices (monthly and annual, in cents). Requires authentication. Always quote prices from here, never from memory.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listMailboxes: List your mailboxes with plan, payment term, status, and next renewal date. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listMySshKeys: List the SSH keys stored on your account, with their ids and SHA256 fingerprints. Use this to check whether a key is already stored and to get the ids to pass to orderVps or buildVpsInstance. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listMyVpsInstances: List all VPS instances owned by the authenticated user. An instanceId from this list is what osirAppDeployToVps takes to put an app on a server the user already owns, at no cost. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listPendingTransfers: List all pending incoming (gaining) domain transfers. Requires authentication. Returns each transfer with its status, request date, current registrar, and expected completion.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listUserDomains: List all domains owned by the authenticated user. No parameters required. Must be authenticated first.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listVpsLocations: List available VPS hosting locations (cities/countries) with available packages. No authentication required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}listVpsOsTemplates: List operating system templates available to install. Requires authentication. Pass EXACTLY ONE of packageId (to pick an operatingSystemId for orderVps, so the server arrives with an OS on it) or instanceId (to pick a template for reinstalling via buildVpsInstance). The two are not interchangeable: the available set depends on the package. Template ids change over time, so always resolve an id here rather than reusing a remembered or hardcoded one.
| Argument | Type | Description |
|---|---|---|
| packageId | string | VPS package id from listVpsPackages; use BEFORE ordering to pick an operatingSystemId for orderVps. |
| includeEol | boolean | Include end-of-life templates (default false). |
| instanceId | string | VPS instance id from listMyVpsInstances; use to see what an existing server can be reinstalled with via buildVpsInstance. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"packageId": {
"type": "string",
"description": "VPS package id from listVpsPackages; use BEFORE ordering to pick an operatingSystemId for orderVps."
},
"includeEol": {
"type": "boolean",
"description": "Include end-of-life templates (default false)."
},
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances; use to see what an existing server can be reinstalled with via buildVpsInstance."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}listVpsPackages: List available VPS hosting packages with pricing, specs, and locations. No authentication required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}lockDomain: Enable registrar lock on a domain to prevent unauthorized transfers.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to lock, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to lock, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}loginToVpsPanel: Generate a one-time login URL to the VPS control panel (VirtFusion) for managing the server. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string | VPS instance id from listMyVpsInstances. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"instanceId"
],
"properties": {
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}loginWithDevice: Start a device authorization login (RFC 8628). Returns a verificationUri and userCode. Open the URI in your browser, enter the code, and sign in with your OSIR credentials. Then call checkDeviceLoginStatus with the returned deviceCode to complete login. No parameters required.
No arguments.
{
"type": "object",
"required": [],
"properties": {}
}logout: Log out: revokes the session's tokens at the identity provider immediately. Optional: sessionKey (from checkDeviceLoginStatus); pass it to end that conversation session.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}orderVps: Stage an order for a new VPS instance; deducts from account balance. If this server is being ordered to host an Osir app, do NOT configure it by hand afterwards: deploy the app with osirAppDeploy, then put it on the box with osirAppDeployToVps. Requires authentication. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| hostname* | string | Hostname for the new server, e.g. 'myserver.example.com'. |
| packageId* | string | VPS package id from listVpsPackages. |
| sshKeyIds | array | Integer SSH key ids from listMySshKeys or addSshKey, injected during install; without one you cannot log in. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| paymentTerm* | string | Billing cycle: 'MONTHLY', 'SEMI_ANNUAL', 'ANNUAL', 'BIENNIAL', or 'TRIENNIAL'. |
| operatingSystemId | integer | Integer OS template id resolved with listVpsOsTemplates using this same packageId; omit to get a server with NO operating system installed. |
osirAppCreateUpload: Create an upload ticket for deploying app source code to Osir. Returns an uploadTicket, a putUrl, and instructions to zip the project and upload it. After uploading, call osirAppDeploy with the uploadTicket. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppDelete: Stage deletion of an Osir app. DESTRUCTIVE and irreversible: removes its microVM, image, route, and data. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| appId* | string | App id from osirAppList. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appId"
],
"properties": {
"appId": {
"type": "string",
"description": "App id from osirAppList."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppDeploy: Deploy an app to Osir (free tier) and get a live HTTPS URL; the app runs isolated in a microVM. Deploying an existing app name redeploys it (new version) and applies any secrets set via osirAppSetSecret. A plain static website (HTML/CSS/JS with no framework or build step) is also supported: it is auto-detected and served directly; pass language 'node' for it. To put the app on the user's OWN VPS, server or production box instead, deploy it here first and then call osirAppDeployToVps - never SSH into the box or write an install script. Once an app is on the user's own VPS, redeploying HERE under the same name is how you update it: the platform re-ships it to the box and keeps its domain. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| name* | string | App name: lowercase letters, digits, and hyphens, e.g. 'habit-tracker'. |
| region | string | Region: 'us' or 'al' ('al' is Albania/Tirana); defaults to the platform's home region. |
| language* | string | Runtime language: 'node', 'python', 'php-laravel', or 'go'; use 'node' for a plain static site. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| uploadTicket* | string | Upload ticket from osirAppCreateUpload, after uploading the zipped source to its putUrl. |
osirAppDeployToVps: Deploy a live Osir app onto the user's own VPS / server / production box, moving it off the shared free tier. Use this INSTEAD of SSH, a provisioning or install script, nginx/systemd/TLS configuration, or any manual server setup - the platform ships the app to the box itself over its own deploy key, so the assistant needs no shell access and no outbound SSH. This is the ONLY supported way to put an app on a user's own server or a custom domain. TWO WAYS IN. (1) The user already owns a VPS: pass instanceId (from listMyVpsInstances) and NO packageId - this ATTACHES the app to that server, SPENDS NOTHING and needs no confirmation. (2) No server yet: pass packageId (from listVpsPackages) and the call stages a VPS order (COSTS MONEY): returns an actionId; present the price/summary to the user and call executeConfirmedAction only if they approve. Before staging any order this tool checks whether the user ALREADY has a box for this app (its C2 binding, then their own VPS list) and attaches that instead - a retry after a failed move never buys a second server. After the move starts the platform ships the app onto the box server-side, which takes about two minutes; watch it with osirAppStatus ('ownedMove'). Calling this tool again while a move is still running just reports its progress, and calling it after one FAILED retries the ship - unless osirAppStatus says the VPS refused the Osir deploy key or its web ports are taken: then retry only after the user has made the changes that message lists. If the result status is BUILDING or BUILD_FAILED, follow its nextStep. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain | string | Custom domain to serve the app on; DNS is bound automatically if the domain is hosted on osir.app nameservers, otherwise the result returns the IP and manual DNS instructions. |
| appName* | string | The deployed app's name, as shown by osirAppList. |
| packageId |
osirAppGetSource: Get a short-lived signed download URL for an Osir app's current source zip. Use this to make edits to a deployed app without the user re-attaching the project: download, patch the files, then osirAppCreateUpload (PUT the new zip) and osirAppDeploy under the SAME name; the platform rebuilds and, for owned-tier apps, auto-ships the new version to the user's box. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| appName* | string | The deployed app's name, as shown by osirAppList. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appName"
],
"properties": {
"appName": {
"type": "string",
"description": "The deployed app's name, as shown by osirAppList."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppList: List the authenticated user's deployed Osir apps with their live URLs and status. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [],
"properties": {
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppLogs: Get recent logs from an Osir app's microVM ('why is my app broken?'). Requires authentication.
| Argument | Type | Description |
|---|---|---|
| tail | integer | Number of recent log lines to return (default 100). |
| appId* | string | App id from osirAppList. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appId"
],
"properties": {
"tail": {
"type": "integer",
"description": "Number of recent log lines to return (default 100)."
},
"appId": {
"type": "string",
"description": "App id from osirAppList."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppProvisionDatabase: Provision a managed Postgres database for an Osir app. The connection string is stored as the app's DATABASE_URL secret (encrypted, injected on the next osirAppDeploy) and is NEVER returned. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| appId* | string | App id from osirAppList. |
| engine | string | Database engine; only 'postgres' (the default) is supported. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appId"
],
"properties": {
"appId": {
"type": "string",
"description": "App id from osirAppList."
},
"engine": {
"type": "string",
"description": "Database engine; only 'postgres' (the default) is supported."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppSetSecret: Set an environment secret for an Osir app (e.g. DATABASE_URL, API_KEY). The value is stored encrypted and injected as an env var on the next osirAppDeploy of the app; it is NEVER returned or logged. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| key* | string | Environment variable name, e.g. 'API_KEY'. |
| appId* | string | App id from osirAppList. |
| value* | string | The secret value; never returned or logged. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appId",
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Environment variable name, e.g. 'API_KEY'."
},
"appId": {
"type": "string",
"description": "App id from osirAppList."
},
"value": {
"type": "string",
"description": "The secret value; never returned or logged."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirAppStatus: Get an Osir app's current status, live URL, and health ('is my app working?'). If the status is BUILD_FAILED, 'recentErrors' explains why so you can fix the source and redeploy. 'qa' is an independent black-box check of the LIVE app after deploy: qa.status PASSED means it loaded and worked; FAILED means it deployed but didn't actually work, and qa.findings lists the problems so you can fix and redeploy. 'ownedMove' tracks a move onto the user's own VPS, which leaves tier and status unchanged while it runs: state MOVING (in progress, stage says where, ~2 minutes in total), MOVED (done - tier reads 'owned'), FAILED or REFUSED (follow this result's message: usually call osirAppDeployToVps again to retry, which never orders a second server; but when the VPS refused the Osir deploy key or its web ports are taken, the user must fix the VPS first, and the message says how). Requires authentication.
| Argument | Type | Description |
|---|---|---|
| appId* | string | App id from osirAppList or a deploy result. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appId"
],
"properties": {
"appId": {
"type": "string",
"description": "App id from osirAppList or a deploy result."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}osirSiteDesignBrief: Step 1 of designing a NEW website with OSIR. Validates the brief and returns 'systemPrompt', the structured design brief and constraints YOU must then follow to write one complete self-contained HTML page, plus 'editRules' for later revisions. Call it before osirSitePublish for a new site, then publish the finished page with osirSitePublish. No authentication needed.
| Argument | Type | Description |
|---|---|---|
| pageJob* | string | The page's single job: get_contact, sell_product, book_appointment, collect_signups, inform_portfolio, or other. |
| audience* | string | Who visits the site and why. |
| whatItIs* | string | What the business concretely does or sells. |
| briefJson | string | Optional JSON object with extras the user provided: site_type, sections[], language (ISO code, default en), tone (warm|premium|playful|technical|minimal|bold), mood_words[] (max 5), brand{logo_url, primary_color '#RRGGBB', secondary_color, fonts[], existing_site_url, references[{url, what_you_like}] (max 3; direction only, never copied), dislikes}, content{tagline, services_or_products[{name,description,price}], about_text, contact{phone,email,address,hours,social[]}, image_urls[], testimonials[{quote,name}] (real only)}, constraints{dark_mode, animations (none|subtle|expressive), form_endpoint, legal_footer}. Ask the user rather than inventing values; skipped extras are fine. |
| businessName |
osirSitePublish: Publish a single-page website to a live HTTPS URL on Osir (free tier). ANY complete HTML document works: the user's own site, a page designed in this chat, or one from the osirSiteDesignBrief flow. Calling again with the same name redeploys the new version. For MULTI-FILE sites (separate CSS/JS/images) use osirAppCreateUpload + osirAppDeploy with a zip instead. Then poll osirAppStatus until READY. If the app was moved to the user's own VPS, redeploying under the same name updates it there and keeps its domain. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| html* | string | The complete <html> document to publish (max 1 MiB). |
| name* | string | Site name: lowercase letters, digits, and hyphens, e.g. 'bar-mediterran'. |
| region | string | Region: 'us' or 'al' ('al' is Albania/Tirana). |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| designContract | boolean | Set true ONLY for pages generated via the osirSiteDesignBrief flow; additionally enforces its output contract (exactly one <h1>, self-contained, no external scripts/CSS except Google Fonts, no iframes). Never set it for a user's own site. |
{
"type": "object",
"required": [
"name",
"html"
],
"properties": {
"html": {
"type": "string",
"description": "The complete <html> document to publish (max 1 MiB)."
},
"name": {
"type": "string",
"description": "Site name: lowercase letters, digits, and hyphens, e.g. 'bar-mediterran'."
},
"region": {
"type": "string",
"description": "Region: 'us' or 'al' ('al' is Albania/Tirana)."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"designContract": {
"type": "boolean",
"description": "Set true ONLY for pages generated via the osirSiteDesignBrief flow; additionally enforces its output contract (exactly one <h1>, self-contained, no external scripts/CSS except Google Fonts, no iframes). Never set it for a user's own site."
}
}
}payInvoice: Stage payment of an outstanding invoice from account balance. Requires authentication. Returns an actionId; present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| invoiceId* | string | The identifier of the outstanding invoice to pay, as returned by listInvoices. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "The identifier of the outstanding invoice to pay, as returned by listInvoices."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}previewPaymentFees: Preview the fees that would be charged for a given payment amount. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| amount* | number | Payment amount to preview, in the account currency as a decimal (e.g. 25.00). |
| currency | string | 3-letter ISO 4217 currency code, default USD. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "Payment amount to preview, in the account currency as a decimal (e.g. 25.00)."
},
"currency": {
"type": "string",
"description": "3-letter ISO 4217 currency code, default USD."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}registerDomain: Stage registration of a new domain name. Deducts from account balance. The DNS zone is initialised automatically after registration (asynchronously; if createDnsRecord right after registration reports a missing zone, retry after a few seconds). Pass initializeDnsZone:false to opt out. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| years* | integer | Registration period in years, 1-10. |
| domain* | string | Fully qualified domain name to register, like "example.com", without scheme. |
| autoRenew | boolean | Enable automatic renewal; defaults to true. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| nameservers* | array | List of nameserver hostnames, e.g. ["ns1.example.com", "ns2.example.com"]. |
| registrantInfo* | object | ICANN registrant contact of the domain owner: firstName, lastName, email, phone (+CC.number), and address (street, city, postalCode, country as 2-letter ISO code). |
| initializeDnsZone |
renewDomain: Stage renewal of a domain for a specified number of years. Deducts from account balance. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| years* | integer | Renewal period in years, 1-10. |
| domain* | string | Fully qualified domain name to renew, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"years"
],
"properties": {
"years": {
"type": "integer",
"description": "Renewal period in years, 1-10."
},
"domain": {
"type": "string",
"description": "Fully qualified domain name to renew, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}setMailboxPassword: Set a new password on a mailbox. Never log or store the password. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| password* | string | The new mailbox password; never log or store it. |
| mailboxId* | string | Mailbox id from listMailboxes. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"mailboxId",
"password"
],
"properties": {
"password": {
"type": "string",
"description": "The new mailbox password; never log or store it."
},
"mailboxId": {
"type": "string",
"description": "Mailbox id from listMailboxes."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}spinDomainWords: Generate domain suggestions by spinning/replacing words with similar alternatives.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language code; default "eng". |
| name* | string | Comma-separated words to spin, e.g. "pizza,restaurant". |
| tlds | string | Comma-separated TLDs without leading dots, e.g. "com,net". |
| position | integer | 0-based index of the word to replace. |
| maxResults | integer | Maximum suggestions to return; default 20. |
| similarity | number | Similarity threshold for replacements, 0.0-1.0. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"lang": {
"type": "string",
"description": "Language code; default \"eng\"."
},
"name": {
"type": "string",
"description": "Comma-separated words to spin, e.g. \"pizza,restaurant\"."
},
"tlds": {
"type": "string",
"description": "Comma-separated TLDs without leading dots, e.g. \"com,net\"."
},
"position": {
"type": "integer",
"description": "0-based index of the word to replace."
},
"maxResults": {
"type": "integer",
"description": "Maximum suggestions to return; default 20."
},
"similarity": {
"type": "number",
"description": "Similarity threshold for replacements, 0.0-1.0."
}
}
}suggestAlternatives: Suggest alternative domain names if the requested one is unavailable. Legacy; prefer generateDomainSuggestions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of suggestions to return; default 10. |
| domain* | string | Fully qualified domain name to find alternatives for, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"limit": {
"type": "integer",
"description": "Maximum number of suggestions to return; default 10."
},
"domain": {
"type": "string",
"description": "Fully qualified domain name to find alternatives for, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}transferDomain: Stage transfer of a domain from another registrar to OSIR. Deducts from account balance. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to transfer, like "example.com", without scheme. |
| authCode* | string | EPP authorization code obtained from the current registrar. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| registrantInfo* | object | ICANN registrant contact of the domain owner: firstName, lastName, email, phone (+CC.number), and address (street, city, postalCode, country as 2-letter ISO code). |
{
"type": "object",
"required": [
"domain",
"authCode",
"registrantInfo"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to transfer, like \"example.com\", without scheme."
},
"authCode": {
"type": "string",
"description": "EPP authorization code obtained from the current registrar."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"registrantInfo": {
"type": "object",
"properties": {
"fax": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"postalCode": {
"type": "string"
}
}
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"organization": {
"type": "string"
}
},
"description": "ICANN registrant contact of the domain owner: firstName, lastName, email, phone (+CC.number), and address (street, city, postalCode, country as 2-letter ISO code)."
}
}
}unlockDomain: Stage removal of registrar lock from a domain to allow transfers. DESTRUCTIVE: reduces domain security. Returns an actionId: present the summary to the user, then call executeConfirmedAction with the actionId if they approve.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to unlock, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to unlock, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}updateContact: Update an existing contact's information. Requires authentication. Only the fields you provide are changed; omitted fields keep their current values. Get the contactId from listContacts. Returns the updated contact.
| Argument | Type | Description |
|---|---|---|
| city | string | New city name. |
| string | New email address. | |
| phone | string | New phone number in '+CC.number' format, e.g. '+1.5551234567'. |
| state | string | New state, province, or region. |
| country | string | New country as a 2-letter ISO 3166-1 alpha-2 code, e.g. 'US'. |
| street1 | string | New first street address line. |
| street2 | string | New second street address line. |
| lastName | string | New last name. |
| contactId* | string | Identifier of the contact to update, as returned by listContacts. |
| firstName | string |
updateDnsRecord: Update an existing DNS record. Requires authentication. Only the fields you provide are changed; omitted fields keep their current values. Get the recordId from listDnsRecords. Returns the updated record.
| Argument | Type | Description |
|---|---|---|
| ttl | integer | New time to live in seconds. |
| name | string | New record name relative to the zone, e.g. 'www' or '@' for the apex. |
| type | string | New record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA. |
| domain* | string | Fully qualified domain name the record belongs to, e.g. 'example.com'. |
| content | string | New record value, e.g. an IPv4 dotted-quad or IPv6 address, hostname, or text. |
| priority | integer | New priority for MX/SRV records only. |
| recordId* | string | Identifier of the record to update, as returned by listDnsRecords. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
updateDomainAutoRenew: Enable or disable auto-renewal for a domain.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name, like "example.com", without scheme. |
| enabled* | boolean | true to enable automatic renewal, false to disable it. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"enabled"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name, like \"example.com\", without scheme."
},
"enabled": {
"type": "boolean",
"description": "true to enable automatic renewal, false to disable it."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}updateDomainPrivacy: Enable or disable WHOIS privacy protection for a domain.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name, like "example.com", without scheme. |
| enabled* | boolean | true to enable WHOIS privacy protection, false to disable it. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain",
"enabled"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name, like \"example.com\", without scheme."
},
"enabled": {
"type": "boolean",
"description": "true to enable WHOIS privacy protection, false to disable it."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}updateNameservers: Update nameservers for a domain. Replaces the current nameserver set with the given list.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name, like "example.com", without scheme. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| nameservers* | array | List of nameserver hostnames, e.g. ["ns1.example.com", "ns2.example.com"]. |
{
"type": "object",
"required": [
"domain",
"nameservers"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name, like \"example.com\", without scheme."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"nameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of nameserver hostnames, e.g. [\"ns1.example.com\", \"ns2.example.com\"]."
}
}
}validateDomainName: Validate if a domain name format is correct. No authentication required.
| Argument | Type | Description |
|---|---|---|
| domain* | string | Fully qualified domain name to validate, like "example.com", without scheme. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Fully qualified domain name to validate, like \"example.com\", without scheme."
}
}
}verifyAccount: Verify a newly created OSIR account with the code from the verification email; step 2 of onboarding, no authentication required. The code is the same token as the email link, so the principal can relay it to their agent. On success the account becomes ACTIVE and billable actions are unlocked. If the code expired, call createAccount again with the same email to get a fresh one.
| Argument | Type | Description |
|---|---|---|
| code* | string | Verification code from the email sent by createAccount. |
| accountId* | string | Account identifier returned by createAccount. |
{
"type": "object",
"required": [
"accountId",
"code"
],
"properties": {
"code": {
"type": "string",
"description": "Verification code from the email sent by createAccount."
},
"accountId": {
"type": "string",
"description": "Account identifier returned by createAccount."
}
}
}verifyMailDns: Check that a mail domain's DNS records resolve; activates the domain for email when all records are found. Returns any still-missing records. Requires authentication.
| Argument | Type | Description |
|---|---|---|
| domain* | string | The mail-enabled domain to verify, e.g. 'example.com'. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The mail-enabled domain to verify, e.g. 'example.com'."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}| Integer OS template id from listVpsOsTemplates, resolved with this same instanceId. |
{
"type": "object",
"required": [
"instanceId",
"operatingSystemId"
],
"properties": {
"swap": {
"type": "number",
"description": "Swap size: 256, 512, or 768 (MB), or 1, 1.5, 2, 3, 4, 5, 6, or 8 (GB)."
},
"hostname": {
"type": "string",
"description": "Hostname for the rebuilt server; defaults to the instance's current hostname."
},
"sshKeyIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Integer SSH key ids from listMySshKeys, injected during install; without one you may not be able to log in."
},
"instanceId": {
"type": "string",
"description": "VPS instance id from listMyVpsInstances."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"operatingSystemId": {
"type": "integer",
"description": "Integer OS template id from listVpsOsTemplates, resolved with this same instanceId."
}
}
}| Version of the OSIR terms the principal accepted, e.g. '2026-09'. |
| acceptedTerms* | boolean | Must be true; requires the principal's actual consent to the OSIR terms of service. |
| principalReference | string | Principal's own reference identifying who the agent acted for, recorded for the audit trail. |
{
"type": "object",
"required": [
"email",
"accountType",
"contact",
"acceptedTerms",
"termsVersion"
],
"properties": {
"email": {
"type": "string",
"description": "Account login email; valid mailbox that receives the verification code."
},
"contact": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"organization": {
"type": "string"
}
},
"description": "The principal's real ICANN registrant contact (firstName, lastName, email, phone, street1, city, country), never the AI agent itself."
},
"password": {
"type": "string",
"description": "Optional account password; if omitted the account is agent-managed until a password is set."
},
"agentName": {
"type": "string",
"description": "Name of the AI agent acting for the principal, recorded for the audit trail."
},
"accountType": {
"type": "string",
"description": "Account type: INDIVIDUAL or ORGANIZATION."
},
"agentVendor": {
"type": "string",
"description": "Vendor of the AI agent acting for the principal, recorded for the audit trail."
},
"termsVersion": {
"type": "string",
"description": "Version of the OSIR terms the principal accepted, e.g. '2026-09'."
},
"acceptedTerms": {
"type": "boolean",
"description": "Must be true; requires the principal's actual consent to the OSIR terms of service."
},
"principalReference": {
"type": "string",
"description": "Principal's own reference identifying who the agent acted for, recorded for the audit trail."
}
}
}| postalCode* | string | Postal or ZIP code. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| organization | string | Organization or company name, if any. |
{
"type": "object",
"required": [
"firstName",
"lastName",
"email",
"phone",
"street1",
"city",
"postalCode",
"country"
],
"properties": {
"city": {
"type": "string",
"description": "City name."
},
"email": {
"type": "string",
"description": "Contact's email address."
},
"phone": {
"type": "string",
"description": "Phone number in '+CC.number' format, e.g. '+1.5551234567'."
},
"state": {
"type": "string",
"description": "State, province, or region, if applicable."
},
"country": {
"type": "string",
"description": "Country as a 2-letter ISO 3166-1 alpha-2 code, e.g. 'US'."
},
"street1": {
"type": "string",
"description": "First street address line."
},
"street2": {
"type": "string",
"description": "Second street address line, if needed."
},
"lastName": {
"type": "string",
"description": "Contact's last name."
},
"firstName": {
"type": "string",
"description": "Contact's first name."
},
"postalCode": {
"type": "string",
"description": "Postal or ZIP code."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"organization": {
"type": "string",
"description": "Organization or company name, if any."
}
}
}{
"type": "object",
"required": [
"domain",
"name",
"type",
"content"
],
"properties": {
"ttl": {
"type": "integer",
"description": "Time to live in seconds; defaults to 3600 when omitted."
},
"name": {
"type": "string",
"description": "Record name relative to the zone, e.g. 'www', 'mail', or '@' for the apex."
},
"type": {
"type": "string",
"description": "Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA."
},
"domain": {
"type": "string",
"description": "Fully qualified domain name the record belongs to, e.g. 'example.com'."
},
"content": {
"type": "string",
"description": "Record value, e.g. an IPv4 dotted-quad or IPv6 address for A/AAAA, a hostname for CNAME/MX/NS, or text for TXT."
},
"priority": {
"type": "integer",
"description": "Priority for MX/SRV records only; defaults to 0 when omitted."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}| sharedPaymentToken* | string | The Stripe Shared Payment Token, 'spt_...'. Minted for the GROSS amount against the networkId from the insufficient-funds error. Single-use. |
{
"type": "object",
"required": [
"sharedPaymentToken",
"creditCents"
],
"properties": {
"currency": {
"type": "string",
"description": "3-letter ISO 4217 currency code, default USD. Must match the balance currency."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"creditCents": {
"type": "integer",
"description": "NET amount to land in the balance, in minor units (cents). Use fundNetCents from the insufficient-funds error. The card is charged this plus the processing fee."
},
"description": {
"type": "string",
"description": "What the funds are for, e.g. 'Funding registration of example.com'. Lands on the customer's transaction record."
},
"maxChargeCents": {
"type": "integer",
"description": "The usage_limits max_amount the token was minted with, i.e. fundGrossCents. Supplying it lets OSIR reject an impossible charge without calling Stripe."
},
"sharedPaymentToken": {
"type": "string",
"description": "The Stripe Shared Payment Token, 'spt_...'. Minted for the GROSS amount against the networkId from the insufficient-funds error. Single-use."
}
}
}{
"type": "object",
"required": [
"packageId",
"hostname",
"paymentTerm"
],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname for the new server, e.g. 'myserver.example.com'."
},
"packageId": {
"type": "string",
"description": "VPS package id from listVpsPackages."
},
"sshKeyIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Integer SSH key ids from listMySshKeys or addSshKey, injected during install; without one you cannot log in."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"paymentTerm": {
"type": "string",
"description": "Billing cycle: 'MONTHLY', 'SEMI_ANNUAL', 'ANNUAL', 'BIENNIAL', or 'TRIENNIAL'."
},
"operatingSystemId": {
"type": "integer",
"description": "Integer OS template id resolved with listVpsOsTemplates using this same packageId; omit to get a server with NO operating system installed."
}
}
}{
"type": "object",
"required": [
"name",
"language",
"uploadTicket"
],
"properties": {
"name": {
"type": "string",
"description": "App name: lowercase letters, digits, and hyphens, e.g. 'habit-tracker'."
},
"region": {
"type": "string",
"description": "Region: 'us' or 'al' ('al' is Albania/Tirana); defaults to the platform's home region."
},
"language": {
"type": "string",
"description": "Runtime language: 'node', 'python', 'php-laravel', or 'go'; use 'node' for a plain static site."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"uploadTicket": {
"type": "string",
"description": "Upload ticket from osirAppCreateUpload, after uploading the zipped source to its putUrl."
}
}
}| string |
| VPS package id from listVpsPackages. Required ONLY when a server has to be ordered; omit it when passing instanceId. |
| instanceId | string | Id of a VPS the user ALREADY owns, from listMyVpsInstances. Given this, the app is attached to that server and nothing is ordered or charged. Never invent one. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
{
"type": "object",
"required": [
"appName"
],
"properties": {
"domain": {
"type": "string",
"description": "Custom domain to serve the app on; DNS is bound automatically if the domain is hosted on osir.app nameservers, otherwise the result returns the IP and manual DNS instructions."
},
"appName": {
"type": "string",
"description": "The deployed app's name, as shown by osirAppList."
},
"packageId": {
"type": "string",
"description": "VPS package id from listVpsPackages. Required ONLY when a server has to be ordered; omit it when passing instanceId."
},
"instanceId": {
"type": "string",
"description": "Id of a VPS the user ALREADY owns, from listMyVpsInstances. Given this, the app is attached to that server and nothing is ordered or charged. Never invent one."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}| string |
| The business or project name. |
| primaryAction* | string | The one primary call to action, e.g. 'Book a table'. |
{
"type": "object",
"required": [
"businessName",
"whatItIs",
"audience",
"pageJob",
"primaryAction"
],
"properties": {
"pageJob": {
"type": "string",
"description": "The page's single job: get_contact, sell_product, book_appointment, collect_signups, inform_portfolio, or other."
},
"audience": {
"type": "string",
"description": "Who visits the site and why."
},
"whatItIs": {
"type": "string",
"description": "What the business concretely does or sells."
},
"briefJson": {
"type": "string",
"description": "Optional JSON object with extras the user provided: site_type, sections[], language (ISO code, default en), tone (warm|premium|playful|technical|minimal|bold), mood_words[] (max 5), brand{logo_url, primary_color '#RRGGBB', secondary_color, fonts[], existing_site_url, references[{url, what_you_like}] (max 3; direction only, never copied), dislikes}, content{tagline, services_or_products[{name,description,price}], about_text, contact{phone,email,address,hours,social[]}, image_urls[], testimonials[{quote,name}] (real only)}, constraints{dark_mode, animations (none|subtle|expressive), form_endpoint, legal_footer}. Ask the user rather than inventing values; skipped extras are fine."
},
"businessName": {
"type": "string",
"description": "The business or project name."
},
"primaryAction": {
"type": "string",
"description": "The one primary call to action, e.g. 'Book a table'."
}
}
}| boolean |
| Initialise the DNS zone after registration; defaults to true. |
| privacyProtection | boolean | Enable WHOIS privacy protection; defaults to true. |
{
"type": "object",
"required": [
"domain",
"years",
"registrantInfo",
"nameservers"
],
"properties": {
"years": {
"type": "integer",
"description": "Registration period in years, 1-10."
},
"domain": {
"type": "string",
"description": "Fully qualified domain name to register, like \"example.com\", without scheme."
},
"autoRenew": {
"type": "boolean",
"description": "Enable automatic renewal; defaults to true."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"nameservers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of nameserver hostnames, e.g. [\"ns1.example.com\", \"ns2.example.com\"]."
},
"registrantInfo": {
"type": "object",
"properties": {
"fax": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"postalCode": {
"type": "string"
}
}
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"organization": {
"type": "string"
}
},
"description": "ICANN registrant contact of the domain owner: firstName, lastName, email, phone (+CC.number), and address (street, city, postalCode, country as 2-letter ISO code)."
},
"initializeDnsZone": {
"type": "boolean",
"description": "Initialise the DNS zone after registration; defaults to true."
},
"privacyProtection": {
"type": "boolean",
"description": "Enable WHOIS privacy protection; defaults to true."
}
}
}| New first name. |
| postalCode | string | New postal or ZIP code. |
| sessionKey | string | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |
| organization | string | New organization or company name. |
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"city": {
"type": "string",
"description": "New city name."
},
"email": {
"type": "string",
"description": "New email address."
},
"phone": {
"type": "string",
"description": "New phone number in '+CC.number' format, e.g. '+1.5551234567'."
},
"state": {
"type": "string",
"description": "New state, province, or region."
},
"country": {
"type": "string",
"description": "New country as a 2-letter ISO 3166-1 alpha-2 code, e.g. 'US'."
},
"street1": {
"type": "string",
"description": "New first street address line."
},
"street2": {
"type": "string",
"description": "New second street address line."
},
"lastName": {
"type": "string",
"description": "New last name."
},
"contactId": {
"type": "string",
"description": "Identifier of the contact to update, as returned by listContacts."
},
"firstName": {
"type": "string",
"description": "New first name."
},
"postalCode": {
"type": "string",
"description": "New postal or ZIP code."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
},
"organization": {
"type": "string",
"description": "New organization or company name."
}
}
}{
"type": "object",
"required": [
"domain",
"recordId"
],
"properties": {
"ttl": {
"type": "integer",
"description": "New time to live in seconds."
},
"name": {
"type": "string",
"description": "New record name relative to the zone, e.g. 'www' or '@' for the apex."
},
"type": {
"type": "string",
"description": "New record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA."
},
"domain": {
"type": "string",
"description": "Fully qualified domain name the record belongs to, e.g. 'example.com'."
},
"content": {
"type": "string",
"description": "New record value, e.g. an IPv4 dotted-quad or IPv6 address, hostname, or text."
},
"priority": {
"type": "integer",
"description": "New priority for MX/SRV records only."
},
"recordId": {
"type": "string",
"description": "Identifier of the record to update, as returned by listDnsRecords."
},
"sessionKey": {
"type": "string",
"description": "Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth."
}
}
}