Register a Workspace and Get an API Key
registerWorkspaceCreate a new TotalPath workspace and receive an API key for it. No account, key or human is needed to call this. It is the first step for an agent that has no TotalPath credential yet.
USE WHEN:
- You have no TotalPath API key and want to start using this server
- You have been asked to set up TotalPath from scratch
DO NOT USE WHEN:
- You already hold a TotalPath API key. Calling this again creates a second, separate, empty workspace. It does not add anything to the one you have.
WHAT YOU GET BACK:
- workspaceId: the new workspace's id
- apiKey: your credential, beginning nq_. It is shown ONCE and cannot be retrieved again. Send it as the x-api-key header on every later call to this server (or Authorization: Bearer). Keep it out of transcripts and logs where you can.
- keyPrefix: the first characters of the key, safe to show a person
- scopes: what the key may do. It can create mappings and tests and read the balance. It can never buy capacity or change billing.
WHAT THE WORKSPACE CAN DO AT THIS POINT:
Create records only. It has NO calling capacity and cannot place a phone call until a human has verified a mobile number for it. Next, call requestAnchorCode.
RATE LIMITS:
A few registrations per hour from one network address. A refusal carries retryAfterSeconds. Do not retry in a loop.
RELATED TOOLS:
- requestAnchorCode, then verifyAnchorCode: unlock calling capacity by verifying a human's mobile
- getClaimLink: hand the workspace to a human so they can own it and pay for more capacity
- getWorkspaceUsage: read the balanceTool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "registerWorkspace"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | A label for the workspace, up to 100 characters. Optional. Use the name of the product or team the calls are for, so the human who later claims the workspace recognises it. |