signup
Redeem a private-beta code and create an account. No API key needed.
Standard codes are single-use with ten product requests. Owner codes are reusable
and unlimited. Signup retains 500 credits as a compatibility balance, while
customer pricing is zero during beta. An exact idempotent replay returns the same
account and same derived API key without a second redemption.
Errors: beta_access_denied, invalid_request, idempotency_conflict, rate_limited.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name for the account, 1-100 chars. Purely a label (it is never checked for uniqueness); defaults to 'agent'. | agent |
| No | OPTIONAL contact address. Never required, never verified, and never used to authenticate; the api_key is the only credential. | ||
| idempotency_key | Yes | Required replay key for beta signup. Reuse it only for exact retries. | |
| beta_access_code | Yes | Private-beta invite code: exactly eight ASCII digits. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| docs | No | Where to read more, keyed by topic. | |
| note | No | Human-readable summary of the above. | |
| tier | No | owner (unlimited) or standard (ten product requests). | |
| api_key | No | The API key. An exact signup replay recovers the same derived value without storing the plaintext in SQLite. | |
| credits | No | Compatibility balance: 500 for a fresh beta account. Beta operations do not spend it. | |
| replayed | No | true when this response replays an earlier signup with the same code and idempotency_key; false on a fresh redemption. | |
| unlimited | No | true only for the owner tier. | |
| account_id | No | Your account id. Not a credential. | |
| created_at | No | Account creation time, ISO-8601 UTC. | |
| next_steps | No | Ordered suggestions for what to call next. | |
| memory_card | No | A compact block worth persisting into your own memory. | |
| request_limit | No | 10 for standard; null for owner. | |
| requests_used | No | Product requests admitted so far. | |
| api_key_prefix | No | First 12 chars of the key, safe to log and to pass to revoke_key. | |
| requests_remaining | No | Remaining product requests; null for owner. |