System
System tools operate on your account, rather than on the contents of your knowledge bases. They read and write the public name that identifies you on the public web site, and may be called by any account holding a valid API key.
GetPublicName
Reads the public area name that your account uses for the knowledge bases you publish online. This is the name claimed with SetPublicName.
Parameters
None.
Returns
The public name held by your account, or nothing when no name has been claimed yet or the call carries no valid API key.
SetPublicName
destructiveClaims the public name that identifies your account on the public web site. A public name belongs to a single account, so a name that another account already holds is rejected. Names are compared without regard to case: two accounts cannot differ by capitalisation alone. Surrounding spaces are trimmed before the name is stored.
Parameters
| Name | Type | Description |
|---|---|---|
publicName | string | The public name to claim, which must not already be used by another account. |
Returns
true when the name was stored against your account, and false
when it is empty or is already used by another account. Setting the name you already hold
succeeds and returns true.
Notes
Any account may call this tool, but a call without a valid API key fails with an unauthorized access error.